Require cl for `declare'.
[gnus] / lisp / time-date.el
index 829bff8..9d5cc76 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  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:
 
@@ -41,6 +39,9 @@
 
 ;;; 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.
 
@@ -97,7 +98,7 @@ and type 2 is the list (HIGH LOW MICRO)."
 
 ;;;###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."
   (condition-case ()
       (apply 'encode-time
             (parse-time-string
@@ -110,6 +111,7 @@ and type 2 is the list (HIGH LOW MICRO)."
              (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."
@@ -159,7 +161,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))
@@ -177,7 +179,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)
@@ -213,7 +215,7 @@ DATE1 and DATE2 should be date-time strings."
 
 ;;;###autoload
 (defun time-to-day-in-year (time)
-  "Return the day number within the year of the date month/day/year."
+  "Return the day number within the year corresponding to TIME."
   (let* ((tim (decode-time time))
         (month (nth 4 tim))
         (day (nth 3 tim))
@@ -247,7 +249,7 @@ The number of days will be returned as a floating point number."
 
 ;;;###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)
@@ -291,6 +293,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 Emacs 21.  So when compiling
+       ;; Gnus (`time-date.el' is part of Gnus) with Emacs 21, 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)
@@ -334,5 +340,5 @@ This function does not work for SECONDS greater than `most-positive-fixnum'."
 
 (provide 'time-date)
 
-;;; arch-tag: addcf07b-b20a-465b-af72-550b8ac5190f
+;; arch-tag: addcf07b-b20a-465b-af72-550b8ac5190f
 ;;; time-date.el ends here