time-date.el 14.8 KB
Newer Older
1
;;; time-date.el --- Date and time handling functions
2

3
;; Copyright (C) 1998-2014 Free Software Foundation, Inc.
Gerd Moellmann's avatar
Gerd Moellmann committed
4 5 6 7 8 9 10

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

;; This file is part of GNU Emacs.

11
;; GNU Emacs is free software: you can redistribute it and/or modify
Gerd Moellmann's avatar
Gerd Moellmann committed
12
;; it under the terms of the GNU General Public License as published by
13 14
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
Gerd Moellmann's avatar
Gerd Moellmann committed
15 16 17

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
Gerd Moellmann's avatar
Gerd Moellmann committed
19 20 21
;; GNU General Public License for more details.

;; 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/>.
Gerd Moellmann's avatar
Gerd Moellmann committed
23 24 25

;;; Commentary:

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 29 30 31 32
;; 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
33 34 35
;; 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.
36

Gerd Moellmann's avatar
Gerd Moellmann committed
37 38
;;; Code:

39 40 41 42 43 44
(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
45
\(HIGH-SYMBOL LOW-SYMBOL MICRO-SYMBOL [PICO-SYMBOL [TYPE-SYMBOL]] TIME-VALUE).
46
The time value TIME-VALUE is decoded and the result is bound to
47
the symbols HIGH-SYMBOL, LOW-SYMBOL and MICRO-SYMBOL.
48
The optional PICO-SYMBOL is bound to the picoseconds part.
49 50 51

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
52 53
LOW), type 2 is the list (HIGH LOW MICRO), and type 3 is the
list (HIGH LOW MICRO PICO)."
54 55 56 57 58 59 60 61
  (declare (indent 1)
	   (debug ((&rest (symbolp symbolp symbolp &or [symbolp form] form))
		   body)))
  (if varlist
      (let* ((elt (pop varlist))
	     (high (pop elt))
	     (low (pop elt))
	     (micro (pop elt))
62 63
	     (pico (unless (<= (length elt) 2)
		     (pop elt)))
64 65 66 67 68 69 70
	     (type (unless (eq (length elt) 1)
		     (pop elt)))
	     (time-value (car elt))
	     (gensym (make-symbol "time")))
	`(let* ,(append `((,gensym ,time-value)
			  (,high (pop ,gensym))
			  ,low ,micro)
71
			(when pico `(,pico))
72
			(when type `(,type)))
73
	   (or ,gensym (setq ,gensym (current-time)))
74 75 76 77
	   (if (consp ,gensym)
	       (progn
		 (setq ,low (pop ,gensym))
		 (if ,gensym
78 79 80 81 82 83 84 85 86 87
		     (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))))
88
		   ,(append `(setq ,micro 0)
89
			    (when pico `(,pico 0))
90 91
			    (when type `(,type 1)))))
	     ,(append `(setq ,low ,gensym ,micro 0)
92
		      (when pico `(,pico 0))
93 94 95 96
		      (when type `(,type 0))))
	   (with-decoded-time-value ,varlist ,@body)))
    `(progn ,@body)))

97 98
(defun encode-time-value (high low micro pico &optional type)
  "Encode HIGH, LOW, MICRO, and PICO into a time value of type TYPE.
99
Type 0 is the cons cell (HIGH . LOW), type 1 is the list (HIGH LOW),
100 101 102 103
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."
104 105 106
  (cond
   ((eq type 0) (cons high low))
   ((eq type 1) (list high low))
107 108 109
   ((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))))
Gerd Moellmann's avatar
Gerd Moellmann committed
110

111 112 113 114
(when (featurep 'emacs)
  (make-obsolete 'encode-time-value nil "25.1")
  (make-obsolete 'with-decoded-time-value nil "25.1"))

115
(autoload 'parse-time-string "parse-time")
116 117
(autoload 'timezone-make-date-arpa-standard "timezone")

Gerd Moellmann's avatar
Gerd Moellmann committed
118
;;;###autoload
119 120 121 122
;; `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.
Gerd Moellmann's avatar
Gerd Moellmann committed
123
(defun date-to-time (date)
124 125
  "Parse a string DATE that represents a date-time and return a time value.
If DATE lacks timezone information, GMT is assumed."
Paul Eggert's avatar
Paul Eggert committed
126
  (condition-case err
127
      (apply 'encode-time (parse-time-string date))
Paul Eggert's avatar
Paul Eggert committed
128 129 130 131 132 133 134 135 136 137 138 139
    (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)))))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
140

141 142 143
;; 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.
144 145 146
;;;###autoload(if (or (featurep 'emacs)
;;;###autoload        (and (fboundp 'float-time)
;;;###autoload             (subrp (symbol-function 'float-time))))
147
;;;###autoload    (defalias 'time-to-seconds 'float-time)
148 149 150
;;;###autoload  (autoload 'time-to-seconds "time-date"))

(eval-when-compile
151 152 153
  (or (featurep 'emacs)
      (and (fboundp 'float-time)
           (subrp (symbol-function 'float-time)))
154 155 156 157 158 159
      (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)
160
             low
161
	     (/ (+ (* micro 1e6) pico) 1e12))))))
Gerd Moellmann's avatar
Gerd Moellmann committed
162

163
;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
164
(defun seconds-to-time (seconds)
165 166
  "Convert SECONDS to a time value."
  (time-add 0 seconds))
Gerd Moellmann's avatar
Gerd Moellmann committed
167

168
;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
169
(defun days-to-time (days)
170
  "Convert DAYS into a time value."
171 172 173 174 175
  (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))
Gerd Moellmann's avatar
Gerd Moellmann committed
176

177
;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
178
(defun time-since (time)
179 180
  "Return the time elapsed since TIME.
TIME should be either a time value or a date-time string."
Gerd Moellmann's avatar
Gerd Moellmann committed
181 182 183
  (when (stringp time)
    ;; Convert date strings to internal time.
    (setq time (date-to-time time)))
184
  (time-subtract nil time))
Gerd Moellmann's avatar
Gerd Moellmann committed
185

186 187 188
;;;###autoload
(defalias 'subtract-time 'time-subtract)

189 190 191 192
;; 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")
Gerd Moellmann's avatar
Gerd Moellmann committed
193

194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248
(eval-when-compile
  (when (not (featurep 'emacs))

    (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)))))))))))
249 250

;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
251
(defun date-to-day (date)
252 253
  "Return the number of days between year 1 and DATE.
DATE should be a date-time string."
Gerd Moellmann's avatar
Gerd Moellmann committed
254 255
  (time-to-days (date-to-time date)))

256
;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
257
(defun days-between (date1 date2)
258 259
  "Return the number of days between DATE1 and DATE2.
DATE1 and DATE2 should be date-time strings."
Gerd Moellmann's avatar
Gerd Moellmann committed
260 261
  (- (date-to-day date1) (date-to-day date2)))

262
;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
263 264 265 266 267 268
(defun date-leap-year-p (year)
  "Return t if YEAR is a leap year."
  (or (and (zerop (% year 4))
	   (not (zerop (% year 100))))
      (zerop (% year 400))))

269 270 271
(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))
Gerd Moellmann's avatar
Gerd Moellmann committed
272 273 274 275 276 277 278 279 280
	 (day (nth 3 tim))
	 (year (nth 5 tim))
	 (day-of-year (+ day (* 31 (1- month)))))
    (when (> month 2)
      (setq day-of-year (- day-of-year (/ (+ 23 (* 4 month)) 10)))
      (when (date-leap-year-p year)
	(setq day-of-year (1+ day-of-year))))
    day-of-year))

281 282 283 284 285
;;;###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)))

286
;;;###autoload
Gerd Moellmann's avatar
Gerd Moellmann committed
287 288
(defun time-to-days (time)
  "The number of days between the Gregorian date 0001-12-31bce and TIME.
289
TIME should be a time value.
Gerd Moellmann's avatar
Gerd Moellmann committed
290 291 292
The Gregorian date Sunday, December 31, 1bce is imaginary."
  (let* ((tim (decode-time time))
	 (year (nth 5 tim)))
293
    (+ (time-date--day-in-year tim)	;	Days this year
Gerd Moellmann's avatar
Gerd Moellmann committed
294 295 296 297 298
       (* 365 (1- year))		;	+ Days in prior years
       (/ (1- year) 4)			;	+ Julian leap years
       (- (/ (1- year) 100))		;	- century years
       (/ (1- year) 400))))		;	+ Gregorian leap years

299 300 301 302 303 304 305 306 307
(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)))
308

Gerd Moellmann's avatar
Gerd Moellmann committed
309 310
;;;###autoload
(defun safe-date-to-time (date)
311
  "Parse a string DATE that represents a date-time and return a time value.
312
If DATE is malformed, return a time value of zeros."
Gerd Moellmann's avatar
Gerd Moellmann committed
313 314 315 316
  (condition-case ()
      (date-to-time date)
    (error '(0 0))))

Glenn Morris's avatar
Glenn Morris committed
317 318

;;;###autoload
319
(defun format-seconds (string seconds)
Glenn Morris's avatar
Glenn Morris committed
320 321 322 323 324 325 326
  "Use format control STRING to format the number SECONDS.
The valid format specifiers are:
%y is the number of (365-day) years.
%d is the number of days.
%h is the number of hours.
%m is the number of minutes.
%s is the number of seconds.
327
%z is a non-printing control flag (see below).
Glenn Morris's avatar
Glenn Morris committed
328 329 330 331 332 333 334 335 336
%% is a literal \"%\".

Upper-case specifiers are followed by the unit-name (e.g. \"years\").
Lower-case specifiers return only the unit.

\"%\" may be followed by a number specifying a width, with an
optional leading \".\" for zero-padding.  For example, \"%.3Y\" will
return something of the form \"001 year\".

337 338 339
The \"%z\" specifier does not print anything.  When it is used, specifiers
must be given in order of decreasing size.  To the left of \"%z\", nothing
is output until the first non-zero unit is encountered.
Glenn Morris's avatar
Glenn Morris committed
340

341
This function does not work for SECONDS greater than `most-positive-fixnum'."
Glenn Morris's avatar
Glenn Morris committed
342 343 344 345 346
  (let ((start 0)
        (units '(("y" "year"   31536000)
                 ("d" "day"       86400)
                 ("h" "hour"       3600)
                 ("m" "minute"       60)
347 348
                 ("s" "second"        1)
                 ("z")))
Glenn Morris's avatar
Glenn Morris committed
349
        (case-fold-search t)
350
        spec match usedunits zeroflag larger prev name unit num zeropos)
Glenn Morris's avatar
Glenn Morris committed
351 352 353 354
    (while (string-match "%\\.?[0-9]*\\(.\\)" string start)
      (setq start (match-end 0)
            spec (match-string 1 string))
      (unless (string-equal spec "%")
355
        (or (setq match (assoc (downcase spec) units))
Glenn Morris's avatar
Glenn Morris committed
356
            (error "Bad format specifier: `%s'" spec))
357
        (if (assoc (downcase spec) usedunits)
Glenn Morris's avatar
Glenn Morris committed
358
            (error "Multiple instances of specifier: `%s'" spec))
359 360 361 362 363 364 365 366 367 368 369 370 371
        (if (string-equal (car match) "z")
            (setq zeroflag t)
          (unless larger
            (setq unit (nth 2 match)
                  larger (and prev (> unit prev))
                  prev unit)))
        (push match usedunits)))
    (and zeroflag larger
         (error "Units are not in decreasing order of size"))
    (dolist (u units)
      (setq spec (car u)
            name (cadr u)
            unit (nth 2 u))
Glenn Morris's avatar
Glenn Morris committed
372
      (when (string-match (format "%%\\(\\.?[0-9]+\\)?\\(%s\\)" spec) string)
373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
        (if (string-equal spec "z")     ; must be last in units
            (setq string
                  (replace-regexp-in-string
                   "%z" ""
                   (substring string (min (or zeropos (match-end 0))
                                          (match-beginning 0)))))
          ;; Cf article-make-date-line in gnus-art.
          (setq num (floor seconds unit)
                seconds (- seconds (* num unit)))
          ;; Start position of the first non-zero unit.
          (or zeropos
              (setq zeropos (unless (zerop num) (match-beginning 0))))
          (setq string
                (replace-match
                 (format (concat "%" (match-string 1 string) "d%s") num
                         (if (string-equal (match-string 2 string) spec)
                             ""       ; lower-case, no unit-name
                           (format " %s%s" name
                                   (if (= num 1) "" "s"))))
                 t t string))))))
Glenn Morris's avatar
Glenn Morris committed
393 394
  (replace-regexp-in-string "%%" "%" string))

395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410
(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)))
Sam Steingold's avatar
Sam Steingold committed
411
             (concat (format "%.2f" (/ delay (car (cddr here)))) (cadr here))))))
Glenn Morris's avatar
Glenn Morris committed
412

Gerd Moellmann's avatar
Gerd Moellmann committed
413 414 415
(provide 'time-date)

;;; time-date.el ends here