cgit.sxemacs.org Git - gnus/blob - lisp/time-date.el

   1 ;;; time-date.el --- Date and time handling functions
   2
   3 ;; Copyright (C) 1998-2012  Free Software Foundation, Inc.
   4
   5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
   6 ;;      Masanobu Umeda <umerin@mse.kyutech.ac.jp>
   7 ;; Keywords: mail news util
   8
   9 ;; This file is part of GNU Emacs.
  10
  11 ;; GNU Emacs is free software: you can redistribute it and/or modify
  12 ;; it under the terms of the GNU General Public License as published by
  13 ;; the Free Software Foundation, either version 3 of the License, or
  14 ;; (at your option) any later version.
  15
  16 ;; GNU Emacs is distributed in the hope that it will be useful,
  17 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
  18 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19 ;; GNU General Public License for more details.
  20
  21 ;; You should have received a copy of the GNU General Public License
  22 ;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
  23
  24 ;;; Commentary:
  25
  26 ;; Time values come in several formats.  The oldest format is a cons
  27 ;; cell of the form (HIGH . LOW).  This format is obsolete, but still
  28 ;; supported.  The other formats are the lists (HIGH LOW), (HIGH LOW
  29 ;; USEC), and (HIGH LOW USEC PSEC).  These formats specify the time
  30 ;; value equal to HIGH * 2^16 + LOW + USEC * 10^-6 + PSEC * 10^-12
  31 ;; seconds, where missing components are treated as zero.  HIGH can be
  32 ;; negative, either because the value is a time difference, or because
  33 ;; the machine supports negative time stamps that fall before the
  34 ;; epoch.  The macro `with-decoded-time-value' and the
  35 ;; function `encode-time-value' make it easier to deal with these
  36 ;; three formats.  See `time-subtract' for an example of how to use
  37 ;; them.
  38
  39 ;;; Code:
  40
  41 (defmacro with-decoded-time-value (varlist &rest body)
  42   "Decode a time value and bind it according to VARLIST, then eval BODY.
  43
  44 The value of the last form in BODY is returned.
  45
  46 Each element of the list VARLIST is a list of the form
  47 \(HIGH-SYMBOL LOW-SYMBOL MICRO-SYMBOL [PICO-SYMBOL [TYPE-SYMBOL]] TIME-VALUE).
  48 The time value TIME-VALUE is decoded and the result it bound to
  49 the symbols HIGH-SYMBOL, LOW-SYMBOL and MICRO-SYMBOL.
  50 The optional PICO-SYMBOL is bound to the picoseconds part.
  51
  52 The optional TYPE-SYMBOL is bound to the type of the time value.
  53 Type 0 is the cons cell (HIGH . LOW), type 1 is the list (HIGH
  54 LOW), type 2 is the list (HIGH LOW MICRO), and type 3 is the
  55 list (HIGH LOW MICRO PICO)."
  56   (declare (indent 1)
  57            (debug ((&rest (symbolp symbolp symbolp &or [symbolp form] form))
  58                    body)))
  59   (if varlist
  60       (let* ((elt (pop varlist))
  61              (high (pop elt))
  62              (low (pop elt))
  63              (micro (pop elt))
  64              (pico (unless (<= (length elt) 2)
  65                      (pop elt)))
  66              (type (unless (eq (length elt) 1)
  67                      (pop elt)))
  68              (time-value (car elt))
  69              (gensym (make-symbol "time")))
  70         `(let* ,(append `((,gensym ,time-value)
  71                           (,high (pop ,gensym))
  72                           ,low ,micro)
  73                         (when pico `(,pico))
  74                         (when type `(,type)))
  75            (if (consp ,gensym)
  76                (progn
  77                  (setq ,low (pop ,gensym))
  78                  (if ,gensym
  79                      (progn
  80                        (setq ,micro (car ,gensym))
  81                        ,(cond (pico
  82                                `(if (cdr ,gensym)
  83                                     ,(append `(setq ,pico (cadr ,gensym))
  84                                              (when type `(,type 3)))
  85                                   ,(append `(setq ,pico 0)
  86                                            (when type `(,type 2)))))
  87                               (type
  88                                `(setq type 2))))
  89                    ,(append `(setq ,micro 0)
  90                             (when pico `(,pico 0))
  91                             (when type `(,type 1)))))
  92              ,(append `(setq ,low ,gensym ,micro 0)
  93                       (when pico `(,pico 0))
  94                       (when type `(,type 0))))
  95            (with-decoded-time-value ,varlist ,@body)))
  96     `(progn ,@body)))
  97
  98 (defun encode-time-value (high low micro pico &optional type)
  99   "Encode HIGH, LOW, MICRO, and PICO into a time value of type TYPE.
 100 Type 0 is the cons cell (HIGH . LOW), type 1 is the list (HIGH LOW),
 101 type 2 is (HIGH LOW MICRO), and type 3 is (HIGH LOW MICRO PICO).
 102
 103 For backward compatibility, if only four arguments are given,
 104 it is assumed that PICO was omitted and should be treated as zero."
 105   (cond
 106    ((eq type 0) (cons high low))
 107    ((eq type 1) (list high low))
 108    ((eq type 2) (list high low micro))
 109    ((eq type 3) (list high low micro pico))
 110    ((null type) (encode-time-value high low micro 0 pico))))
 111
 112 (autoload 'parse-time-string "parse-time")
 113 (autoload 'timezone-make-date-arpa-standard "timezone")
 114
 115 ;;;###autoload
 116 ;; `parse-time-string' isn't sufficiently general or robust.  It fails
 117 ;; to grok some of the formats that timezone does (e.g. dodgy
 118 ;; post-2000 stuff from some Elms) and either fails or returns bogus
 119 ;; values.  timezone-make-date-arpa-standard should help.
 120 (defun date-to-time (date)
 121   "Parse a string DATE that represents a date-time and return a time value.
 122 If DATE lacks timezone information, GMT is assumed."
 123   (condition-case ()
 124       (apply 'encode-time (parse-time-string date))
 125     (error (condition-case ()
 126                (apply 'encode-time
 127                       (parse-time-string
 128                        (timezone-make-date-arpa-standard date)))
 129              (error (error "Invalid date: %s" date))))))
 130
 131 ;; Bit of a mess.  Emacs has float-time since at least 21.1.
 132 ;; This file is synced to Gnus, and XEmacs packages may have been written
 133 ;; using time-to-seconds from the Gnus library.
 134 ;;;###autoload(if (or (featurep 'emacs)
 135 ;;;###autoload        (and (fboundp 'float-time)
 136 ;;;###autoload             (subrp (symbol-function 'float-time))))
 137 ;;;###autoload    (defalias 'time-to-seconds 'float-time)
 138 ;;;###autoload  (autoload 'time-to-seconds "time-date"))
 139
 140 (eval-when-compile
 141   (or (featurep 'emacs)
 142       (and (fboundp 'float-time)
 143            (subrp (symbol-function 'float-time)))
 144       (defun time-to-seconds (time)
 145         "Convert time value TIME to a floating point number."
 146         (with-decoded-time-value ((high low micro pico type time))
 147           (+ (* 1.0 high 65536)
 148              low
 149              (/ (+ (* micro 1e6) pico) 1e12))))))
 150
 151 ;;;###autoload
 152 (defun seconds-to-time (seconds)
 153   "Convert SECONDS (a floating point number) to a time value."
 154   (let* ((usec (* 1000000 (mod seconds 1)))
 155          (ps (round (* 1000000 (mod usec 1))))
 156          (us (floor usec))
 157          (lo (floor (mod seconds 65536)))
 158          (hi (floor seconds 65536)))
 159     (if (eq ps 1000000)
 160         (progn
 161           (setq ps 0)
 162           (setq us (1+ us))
 163           (if (eq us 1000000)
 164               (progn
 165                 (setq us 0)
 166                 (setq lo (1+ lo))
 167                 (if (eq lo 65536)
 168                     (progn
 169                       (setq lo 0)
 170                       (setq hi (1+ hi))))))))
 171     (list hi lo us ps)))
 172
 173 ;;;###autoload
 174 (defun time-less-p (t1 t2)
 175   "Return non-nil if time value T1 is earlier than time value T2."
 176   (with-decoded-time-value ((high1 low1 micro1 pico1 type1 t1)
 177                             (high2 low2 micro2 pico2 type2 t2))
 178     (or (< high1 high2)
 179         (and (= high1 high2)
 180              (or (< low1 low2)
 181                  (and (= low1 low2)
 182                       (or (< micro1 micro2)
 183                           (and (= micro1 micro2)
 184                                (< pico1 pico2)))))))))
 185
 186 ;;;###autoload
 187 (defun days-to-time (days)
 188   "Convert DAYS into a time value."
 189   (let* ((seconds (* 1.0 days 60 60 24))
 190          (high (condition-case nil (floor (/ seconds 65536))
 191                  (range-error most-positive-fixnum))))
 192     (list high (condition-case nil (floor (- seconds (* 1.0 high 65536)))
 193                  (range-error 65535)))))
 194
 195 ;;;###autoload
 196 (defun time-since (time)
 197   "Return the time elapsed since TIME.
 198 TIME should be either a time value or a date-time string."
 199   (when (stringp time)
 200     ;; Convert date strings to internal time.
 201     (setq time (date-to-time time)))
 202   (time-subtract (current-time) time))
 203
 204 ;;;###autoload
 205 (defalias 'subtract-time 'time-subtract)
 206
 207 ;;;###autoload
 208 (defun time-subtract (t1 t2)
 209   "Subtract two time values, T1 minus T2.
 210 Return the difference in the format of a time value."
 211   (with-decoded-time-value ((high low micro pico type t1)
 212                             (high2 low2 micro2 pico2 type2 t2))
 213     (setq high (- high high2)
 214           low (- low low2)
 215           micro (- micro micro2)
 216           pico (- pico pico2)
 217           type (max type type2))
 218     (when (< pico 0)
 219       (setq micro (1- micro)
 220             pico (+ pico 1000000)))
 221     (when (< micro 0)
 222       (setq low (1- low)
 223             micro (+ micro 1000000)))
 224     (when (< low 0)
 225       (setq high (1- high)
 226             low (+ low 65536)))
 227     (encode-time-value high low micro pico type)))
 228
 229 ;;;###autoload
 230 (defun time-add (t1 t2)
 231   "Add two time values T1 and T2.  One should represent a time difference."
 232   (with-decoded-time-value ((high low micro pico type t1)
 233                             (high2 low2 micro2 pico2 type2 t2))
 234     (setq high (+ high high2)
 235           low (+ low low2)
 236           micro (+ micro micro2)
 237           pico (+ pico pico2)
 238           type (max type type2))
 239     (when (>= pico 1000000)
 240       (setq micro (1+ micro)
 241             pico (- pico 1000000)))
 242     (when (>= micro 1000000)
 243       (setq low (1+ low)
 244             micro (- micro 1000000)))
 245     (when (>= low 65536)
 246       (setq high (1+ high)
 247             low (- low 65536)))
 248     (encode-time-value high low micro pico type)))
 249
 250 ;;;###autoload
 251 (defun date-to-day (date)
 252   "Return the number of days between year 1 and DATE.
 253 DATE should be a date-time string."
 254   (time-to-days (date-to-time date)))
 255
 256 ;;;###autoload
 257 (defun days-between (date1 date2)
 258   "Return the number of days between DATE1 and DATE2.
 259 DATE1 and DATE2 should be date-time strings."
 260   (- (date-to-day date1) (date-to-day date2)))
 261
 262 ;;;###autoload
 263 (defun date-leap-year-p (year)
 264   "Return t if YEAR is a leap year."
 265   (or (and (zerop (% year 4))
 266            (not (zerop (% year 100))))
 267       (zerop (% year 400))))
 268
 269 ;;;###autoload
 270 (defun time-to-day-in-year (time)
 271   "Return the day number within the year corresponding to TIME."
 272   (let* ((tim (decode-time time))
 273          (month (nth 4 tim))
 274          (day (nth 3 tim))
 275          (year (nth 5 tim))
 276          (day-of-year (+ day (* 31 (1- month)))))
 277     (when (> month 2)
 278       (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
 279       (when (date-leap-year-p year)
 280         (setq day-of-year (1+ day-of-year))))
 281     day-of-year))
 282
 283 ;;;###autoload
 284 (defun time-to-days (time)
 285   "The number of days between the Gregorian date 0001-12-31bce and TIME.
 286 TIME should be a time value.
 287 The Gregorian date Sunday, December 31, 1bce is imaginary."
 288   (let* ((tim (decode-time time))
 289          (year (nth 5 tim)))
 290     (+ (time-to-day-in-year time)       ;       Days this year
 291        (* 365 (1- year))                ;       + Days in prior years
 292        (/ (1- year) 4)                  ;       + Julian leap years
 293        (- (/ (1- year) 100))            ;       - century years
 294        (/ (1- year) 400))))             ;       + Gregorian leap years
 295
 296 (defun time-to-number-of-days (time)
 297   "Return the number of days represented by TIME.
 298 Returns a floating point number."
 299   (/ (funcall (eval-when-compile
 300                 (if (or (featurep 'emacs)
 301                         (and (fboundp 'float-time)
 302                              (subrp (symbol-function 'float-time))))
 303                     'float-time
 304                   'time-to-seconds)) time) (* 60 60 24)))
 305
 306 ;;;###autoload
 307 (defun safe-date-to-time (date)
 308   "Parse a string DATE that represents a date-time and return a time value.
 309 If DATE is malformed, return a time value of zeros."
 310   (condition-case ()
 311       (date-to-time date)
 312     (error '(0 0))))
 313
 314 \f
 315 ;;;###autoload
 316 (defun format-seconds (string seconds)
 317   "Use format control STRING to format the number SECONDS.
 318 The valid format specifiers are:
 319 %y is the number of (365-day) years.
 320 %d is the number of days.
 321 %h is the number of hours.
 322 %m is the number of minutes.
 323 %s is the number of seconds.
 324 %z is a non-printing control flag (see below).
 325 %% is a literal \"%\".
 326
 327 Upper-case specifiers are followed by the unit-name (e.g. \"years\").
 328 Lower-case specifiers return only the unit.
 329
 330 \"%\" may be followed by a number specifying a width, with an
 331 optional leading \".\" for zero-padding.  For example, \"%.3Y\" will
 332 return something of the form \"001 year\".
 333
 334 The \"%z\" specifier does not print anything.  When it is used, specifiers
 335 must be given in order of decreasing size.  To the left of \"%z\", nothing
 336 is output until the first non-zero unit is encountered.
 337
 338 This function does not work for SECONDS greater than `most-positive-fixnum'."
 339   (let ((start 0)
 340         (units '(("y" "year"   31536000)
 341                  ("d" "day"       86400)
 342                  ("h" "hour"       3600)
 343                  ("m" "minute"       60)
 344                  ("s" "second"        1)
 345                  ("z")))
 346         (case-fold-search t)
 347         spec match usedunits zeroflag larger prev name unit num zeropos)
 348     (while (string-match "%\\.?[0-9]*\\(.\\)" string start)
 349       (setq start (match-end 0)
 350             spec (match-string 1 string))
 351       (unless (string-equal spec "%")
 352         (or (setq match (assoc (downcase spec) units))
 353             (error "Bad format specifier: `%s'" spec))
 354         (if (assoc (downcase spec) usedunits)
 355             (error "Multiple instances of specifier: `%s'" spec))
 356         (if (string-equal (car match) "z")
 357             (setq zeroflag t)
 358           (unless larger
 359             (setq unit (nth 2 match)
 360                   larger (and prev (> unit prev))
 361                   prev unit)))
 362         (push match usedunits)))
 363     (and zeroflag larger
 364          (error "Units are not in decreasing order of size"))
 365     (dolist (u units)
 366       (setq spec (car u)
 367             name (cadr u)
 368             unit (nth 2 u))
 369       (when (string-match (format "%%\\(\\.?[0-9]+\\)?\\(%s\\)" spec) string)
 370         (if (string-equal spec "z")     ; must be last in units
 371             (setq string
 372                   (replace-regexp-in-string
 373                    "%z" ""
 374                    (substring string (min (or zeropos (match-end 0))
 375                                           (match-beginning 0)))))
 376           ;; Cf article-make-date-line in gnus-art.
 377           (setq num (floor seconds unit)
 378                 seconds (- seconds (* num unit)))
 379           ;; Start position of the first non-zero unit.
 380           (or zeropos
 381               (setq zeropos (unless (zerop num) (match-beginning 0))))
 382           (setq string
 383                 (replace-match
 384                  (format (concat "%" (match-string 1 string) "d%s") num
 385                          (if (string-equal (match-string 2 string) spec)
 386                              ""       ; lower-case, no unit-name
 387                            (format " %s%s" name
 388                                    (if (= num 1) "" "s"))))
 389                  t t string))))))
 390   (replace-regexp-in-string "%%" "%" string))
 391
 392
 393 (provide 'time-date)
 394
 395 ;;; time-date.el ends here