;;; 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>
;; 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:
;;; 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.
;;;###autoload
(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
(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))))
+;; 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)
;;;###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))
;;;###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)
(- (/ (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)
(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)
(provide 'time-date)
-;;; arch-tag: addcf07b-b20a-465b-af72-550b8ac5190f
;;; time-date.el ends here