Merge branch 'master' of https://git.gnus.org/gnus
[gnus] / lisp / time-date.el
index e4cd4e5..52727d7 100644 (file)
@@ -1,7 +1,7 @@
 ;;; time-date.el --- Date and time handling functions
 
 ;; Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006,
-;;   2007, 2008  Free Software Foundation, Inc.
+;;   2007, 2008, 2009, 2010  Free Software Foundation, Inc.
 
 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
 ;;     Masanobu Umeda <umerin@mse.kyutech.ac.jp>
@@ -9,20 +9,18 @@
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; GNU Emacs is free software: you can redistribute it and/or modify
 ;; it under the terms of the GNU General Public License as published by
-;; the Free Software Foundation; either version 3, or (at your option)
-;; any later version.
+;; the Free Software Foundation, either version 3 of the License, or
+;; (at your option) any later version.
 
 ;; GNU Emacs is distributed in the hope that it will be useful,
 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
-;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.         See the
+;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
@@ -96,28 +94,45 @@ and type 2 is the list (HIGH LOW MICRO)."
 (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 that represents a date-time and return a time value."
+  "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))))
-
-;;;###autoload
-(defun time-to-seconds (time)
-  "Convert time value TIME to a floating point number.
-You can use `float-time' instead."
-  (with-decoded-time-value ((high low micro time))
-    (+ (* 1.0 high 65536)
-       low
-       (/ micro 1000000.0))))
+      (apply 'encode-time (parse-time-string date))
+    (error (condition-case ()
+              (apply 'encode-time
+                     (parse-time-string
+                      (timezone-make-date-arpa-standard date)))
+            (error (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.
+;;;###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  (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
+  (unless (fboundp 'with-no-warnings)
+    (defmacro with-no-warnings (&rest body)
+      `(progn ,@body))))
 
 ;;;###autoload
 (defun seconds-to-time (seconds)
@@ -160,7 +175,7 @@ TIME should be either a time value or a date-time string."
 
 ;;;###autoload
 (defun time-subtract (t1 t2)
-  "Subtract two time values.
+  "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))
@@ -178,7 +193,7 @@ Return the difference in the format of a time value."
 
 ;;;###autoload
 (defun time-add (t1 t2)
-  "Add two time values.  One should represent a time difference."
+  "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)
@@ -241,14 +256,21 @@ The Gregorian date Sunday, December 31, 1bce is imaginary."
        (- (/ (1- year) 100))           ;       - century years
        (/ (1- year) 400))))            ;       + Gregorian leap years
 
-(defun time-to-number-of-days (time)
-  "Return the number of days represented by TIME.
+(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."
-  (/ (time-to-seconds time) (* 60 60 24)))
+      (/ (with-no-warnings (time-to-seconds time)) (* 60 60 24)))))
 
 ;;;###autoload
 (defun safe-date-to-time (date)
-  "Parse a string that represents a date-time and return a time value.
+  "Parse a string DATE that represents a date-time and return a time value.
 If DATE is malformed, return a time value of zeros."
   (condition-case ()
       (date-to-time date)
@@ -292,6 +314,10 @@ 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 "%")
+       ;; `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))
             (error "Bad format specifier: `%s'" spec))
         (if (assoc-string spec usedunits t)
@@ -335,5 +361,4 @@ This function does not work for SECONDS greater than `most-positive-fixnum'."
 
 (provide 'time-date)
 
-;;; arch-tag: addcf07b-b20a-465b-af72-550b8ac5190f
 ;;; time-date.el ends here