1 ;;; parse-time.el --- parsing time strings
3 ;; Copyright (C) 1996, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
4 ;; 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Erik Naggum <erik@naggum.no>
9 ;; This file is part of GNU Emacs.
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.
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.
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/>.
26 ;; With the introduction of the `encode-time', `decode-time', and
27 ;; `format-time-string' functions, dealing with time became simpler in
28 ;; Emacs. However, parsing time strings is still largely a matter of
29 ;; heuristics and no common interface has been designed.
31 ;; `parse-time-string' parses a time in a string and returns a list of 9
32 ;; values, just like `decode-time', where unspecified elements in the
33 ;; string are returned as nil. `encode-time' may be applied on these
34 ;; values to obtain an internal time value.
38 (eval-when-compile (require 'cl)) ;and ah ain't kiddin' 'bout it
40 (defvar parse-time-digits (make-vector 256 nil))
42 ;; Byte-compiler warnings
43 (defvar parse-time-elt)
44 (defvar parse-time-val)
46 (unless (aref parse-time-digits ?0)
47 (loop for i from ?0 to ?9
48 do (aset parse-time-digits i (- i ?0))))
50 (defsubst digit-char-p (char)
51 (aref parse-time-digits char))
53 (defsubst parse-time-string-chars (char)
55 (let (case-fold-search str)
56 (cond ((eq char ?+) 1)
59 ((string-match "[[:upper:]]" (setq str (string char))) ?A)
60 ((string-match "[[:lower:]]" str) ?a)
61 ((string-match "[[:digit:]]" str) ?0)))))
63 (put 'parse-error 'error-conditions '(parse-error error))
64 (put 'parse-error 'error-message "Parsing error")
66 (defsubst parse-integer (string &optional start end)
67 "[CL] Parse and return the integer in STRING, or nil if none."
71 (end (or end (length string))))
73 (let ((sign (aref string index)))
74 (if (or (eq sign ?+) (eq sign ?-))
75 (setq sign (parse-time-string-chars sign)
78 (while (and (< index end)
79 (setq digit (digit-char-p (aref string index))))
80 (setq integer (+ (* integer 10) digit)
83 (signal 'parse-error `("not an integer"
84 ,(substring string (or start 0) end)))
87 (defun parse-time-tokenize (string)
88 "Tokenize STRING into substrings."
96 (while (and (< index end) ;skip invalid characters
97 (not (setq c (parse-time-string-chars (aref string index)))))
99 (setq start index all-digits (eq c ?0))
100 (while (and (< (incf index) end) ;scan valid characters
101 (setq c (parse-time-string-chars (aref string index))))
102 (setq all-digits (and all-digits (eq c ?0))))
104 (push (if all-digits (parse-integer string start index)
105 (substring string start index))
109 (defvar parse-time-months '(("jan" . 1) ("feb" . 2) ("mar" . 3)
110 ("apr" . 4) ("may" . 5) ("jun" . 6)
111 ("jul" . 7) ("aug" . 8) ("sep" . 9)
112 ("oct" . 10) ("nov" . 11) ("dec" . 12)
113 ("january" . 1) ("february" . 2)
114 ("march" . 3) ("april" . 4) ("june" . 6)
115 ("july" . 7) ("august" . 8)
116 ("september" . 9) ("october" . 10)
117 ("november" . 11) ("december" . 12)))
118 (defvar parse-time-weekdays '(("sun" . 0) ("mon" . 1) ("tue" . 2)
119 ("wed" . 3) ("thu" . 4) ("fri" . 5)
120 ("sat" . 6) ("sunday" . 0) ("monday" . 1)
121 ("tuesday" . 2) ("wednesday" . 3)
122 ("thursday" . 4) ("friday" . 5)
124 (defvar parse-time-zoneinfo `(("z" 0) ("ut" 0) ("gmt" 0)
125 ("pst" ,(* -8 3600)) ("pdt" ,(* -7 3600) t)
126 ("mst" ,(* -7 3600)) ("mdt" ,(* -6 3600) t)
127 ("cst" ,(* -6 3600)) ("cdt" ,(* -5 3600) t)
128 ("est" ,(* -5 3600)) ("edt" ,(* -4 3600) t))
129 "(zoneinfo seconds-off daylight-savings-time-p)")
131 (defvar parse-time-rules
132 `(((6) parse-time-weekdays)
134 ((4) parse-time-months)
137 ,#'(lambda () (and (stringp parse-time-elt)
138 (= (length parse-time-elt) 8)
139 (= (aref parse-time-elt 2) ?:)
140 (= (aref parse-time-elt 5) ?:)))
142 ((8 7) parse-time-zoneinfo
143 ,#'(lambda () (car parse-time-val))
144 ,#'(lambda () (cadr parse-time-val)))
147 (and (stringp parse-time-elt)
148 (= 5 (length parse-time-elt))
149 (or (= (aref parse-time-elt 0) ?+)
150 (= (aref parse-time-elt 0) ?-))))
151 ,#'(lambda () (* 60 (+ (parse-integer parse-time-elt 3 5)
152 (* 60 (parse-integer parse-time-elt 1 3)))
153 (if (= (aref parse-time-elt 0) ?-) -1 1))))
155 ,#'(lambda () (and (stringp parse-time-elt)
156 (= (length parse-time-elt) 10)
157 (= (aref parse-time-elt 4) ?-)
158 (= (aref parse-time-elt 7) ?-)))
161 ,#'(lambda () (and (stringp parse-time-elt)
162 (= (length parse-time-elt) 5)
163 (= (aref parse-time-elt 2) ?:)))
164 [0 2] [3 5] ,#'(lambda () 0))
166 ,#'(lambda () (and (stringp parse-time-elt)
167 (= (length parse-time-elt) 4)
168 (= (aref parse-time-elt 1) ?:)))
169 [0 1] [2 4] ,#'(lambda () 0))
171 ,#'(lambda () (and (stringp parse-time-elt)
172 (= (length parse-time-elt) 7)
173 (= (aref parse-time-elt 1) ?:)))
175 ((5) (50 110) ,#'(lambda () (+ 1900 parse-time-elt)))
176 ((5) (0 49) ,#'(lambda () (+ 2000 parse-time-elt))))
177 "(slots predicate extractor...)")
178 ;;;###autoload(put 'parse-time-rules 'risky-local-variable t)
181 (defun parse-time-string (string)
182 "Parse the time-string STRING into (SEC MIN HOUR DAY MON YEAR DOW DST TZ).
183 The values are identical to those of `decode-time', but any values that are
184 unknown are returned as nil."
185 (let ((time (list nil nil nil nil nil nil nil nil nil))
186 (temp (parse-time-tokenize (downcase string))))
188 (let ((parse-time-elt (pop temp))
189 (rules parse-time-rules)
191 (while (and rules (not exit))
192 (let* ((rule (pop rules))
194 (predicate (pop rule))
196 (when (and (not (nth (car slots) time)) ;not already set
197 (setq parse-time-val (cond ((and (consp predicate)
198 (not (eq (car predicate)
200 (and (numberp parse-time-elt)
201 (<= (car predicate) parse-time-elt)
202 (<= parse-time-elt (cadr predicate))
205 (cdr (assoc parse-time-elt
206 (symbol-value predicate))))
207 ((funcall predicate)))))
210 (let ((new-val (and rule
211 (let ((this (pop rule)))
215 (aref this 0) (aref this 1))
217 (rplaca (nthcdr (pop slots) time)
218 (or new-val parse-time-val)))))))))
221 (provide 'parse-time)
223 ;; arch-tag: 07066094-45a8-4c68-b307-86195e2c1103
224 ;;; parse-time.el ends here