This is the fuzzy-dates Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 06:09:27 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
fuzzy-datesA library to fuzzily parse date strings
Yukari Hafner <shinmera@tymoon.eu>
Yukari Hafner <shinmera@tymoon.eu>
(GIT https://github.com/shinmera/fuzzy-dates.git)
zlib
1.0.0
cl-ppcre (system).
documentation-utils (system).
package.lisp (file).
fuzzy-dates.lisp (file).
documentation.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
fuzzy-dates/fuzzy-dates.asdfuzzy-dates/package.lispfuzzy-dates/fuzzy-dates.lispfuzzy-dates/documentation.lispfuzzy-dates/fuzzy-dates.lisppackage.lisp (file).
fuzzy-dates (system).
decode-integer (function).
decode-month (function).
decode-timezone (function).
decode-unit (function).
decode-weekday (function).
encode-month (function).
encode-weekday (function).
parse (function).
parse-backward-time (function).
parse-date (function).
parse-forward-time (function).
parse-iso8661-like (function).
parse-reverse-like (function).
parse-rfc1123-like (function).
parse-rfc3339-like (function).
parse-single (function).
print (function).
print-clock (function).
print-date (function).
print-iso8661 (function).
print-relative (function).
print-reverse (function).
print-rfc1123 (function).
print-rfc3339 (function).
*tzdb* (special variable).
backfill-timestamp (function).
check-error (function).
define-parser (macro).
define-printer (macro).
encode-timezone (function).
parse-integer* (function).
parse-relative-time (function).
parse-timezone (function).
parse-tzdb (function).
with-integers-bound (macro).
with-scans (macro).
fuzzy-dates/documentation.lispfuzzy-dates.lisp (file).
fuzzy-dates (system).
Packages are listed by definition order.
org.shirakumo.fuzzy-datescommon-lisp.
decode-integer (function).
decode-month (function).
decode-timezone (function).
decode-unit (function).
decode-weekday (function).
encode-month (function).
encode-weekday (function).
parse (function).
parse-backward-time (function).
parse-date (function).
parse-forward-time (function).
parse-iso8661-like (function).
parse-reverse-like (function).
parse-rfc1123-like (function).
parse-rfc3339-like (function).
parse-single (function).
print (function).
print-clock (function).
print-date (function).
print-iso8661 (function).
print-relative (function).
print-reverse (function).
print-rfc1123 (function).
print-rfc3339 (function).
*tzdb* (special variable).
backfill-timestamp (function).
check-error (function).
define-parser (macro).
define-printer (macro).
encode-timezone (function).
parse-integer* (function).
parse-relative-time (function).
parse-timezone (function).
parse-tzdb (function).
with-integers-bound (macro).
with-scans (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Parse an integer in digit or word format.
If ERRORP is true, failing to parse the month name will signal an
error. Otherwise NIL is returned.
The understood words go from one all the way up to trillion, though no
abbreviations are supported.
Examples:
100
one hundred
twenty-two million three hundred two
Turn a month name into an integer between 1 and 12.
If ERRORP is true, failing to parse the month name will signal an
error. Otherwise NIL is returned.
See http://www.lispworks.com/documentation/HyperSpec/Body/25_ada.htm
Examples:
ja
feb
march
Turn a timezone name into a number of hours of UTC offset.
If ERRORP is true, failing to parse the month name will signal an
error. Otherwise NIL is returned.
See http://www.lispworks.com/documentation/HyperSpec/Body/25_ada.htm
Examples:
Z
GMT
JST
Turn a unit name into a scaling factor relative to seconds.
If ERRORP is true, failing to parse the month name will signal an
error. Otherwise NIL is returned.
The supported time units go from nanoseconds to aeons and includes all
sorts of abbreviations for them.
See http://www.lispworks.com/documentation/HyperSpec/Body/25_ada.htm
Examples:
ms
sec
y
aeons
Turn a weekday name into an integer between 0 and 6.
If ERRORP is true, failing to parse the month name will signal an
error. Otherwise NIL is returned.
See http://www.lispworks.com/documentation/HyperSpec/Body/25_ada.htm
Examples:
mo
tue
thursday
Turn a month identifier [1,12] into its english string name.
See http://www.lispworks.com/documentation/HyperSpec/Body/25_ada.htm See DECODE-MONTH
Turn a weekday identifier [0,6] into its english string name.
See http://www.lispworks.com/documentation/HyperSpec/Body/25_ada.htm See DECODE-WEEKDAY
Fuzzily parse a time string into a universal-time timestamp.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
If ERRORP is true, failing to parse the string name will signal an
error. Otherwise NIL is returned. When an error is signalled, two
restarts will be active:
USE-VALUE – interactive, allows supplying a universal-time to use CONTINUE – simply returns the current universal-time timestamp
This also applies to all the sub-functions used.
See PARSE-FORWARD-TIME
See PARSE-BACKWARD-TIME
See PARSE-DATE
See PARSE-RFC3339-LIKE
See PARSE-ISO8661-LIKE
See PARSE-REVERSE-LIKE
See PARSE-RFC1123-LIKE
See PARSE-SINGLE
Parse a relative time for the past.
The basic syntax is:
STAMP ::= (C U)(,? C U)* ago
C — a positive integer
U — a unit name
Examples:
10 seconds ago
6 years, 5 minutes ago
thirty hours ago
If ERRORP is true, failing to parse the timestring will signal an
error. Otherwise NIL is returned.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
See DECODE-UNIT
See DECODE-INTEGER
See PARSE
Parse a timestamp that only includes a date but not a time.
A typical date string has the following format:
2023.09.16
This function is more lenient, and makes the following fuzzy matches:
It permits the following separators between date parts:
space comma period slash dash
Further, it allows omitting the day part and allows switching the
order around to D M Y rather than the standard Y M D. The american
M D Y format is *not* parsed, as it is ambiguous with Y M D or D M Y
and cannot be distinguished in all cases.
If ERRORP is true, failing to parse the timestring will signal an
error. Otherwise NIL is returned.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
See PARSE
Parse a relative time for the future.
The basic syntax is:
STAMP ::= in (C U)(,? C U)*
C — a positive integer
U — a unit name
Examples:
in 10 seconds
in 5 minutes, 10 years
in five hours
If ERRORP is true, failing to parse the timestring will signal an
error. Otherwise NIL is returned.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
See DECODE-UNIT
See DECODE-INTEGER
See PARSE
Parse a timestamp that looks vaguely like an ISO8661 date.
This is very similar to the RFC3339 format, but instead follows the
compact format without separators between date and time formats.
A typical compact ISO8661 string has the following format:
20230916T100615Z
This function is slightly more lenient and permits the following
separators between date and time parts:
space dash t
It permits date and time parts to not be padded.
It also permits omitting the date and timezone parts of the
timestamp.
If ERRORP is true, failing to parse the timestring will signal an
error. Otherwise NIL is returned.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
See PARSE
Parse a timestamp that is "reverse" from the others
A typical reverse time string has the following format:
10:18:03 16.9.2023
This function is more lenient, and makes the following fuzzy matches:
It permits the following separators between date parts:
space comma period slash dash
It permits the following separators between date and time parts:
space dash t
It permits the following separators between time parts:
space period dash colon
It permits date and time parts to not be padded.
It also permits omitting the time and timezone parts of the
timestamp.
If ERRORP is true, failing to parse the timestring will signal an
error. Otherwise NIL is returned.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
See PARSE
Parse a timestamp that looks vaguely like an RFC1123 date.
A typical RFC1123 string has the following format:
Thu, 23 Jul 2013 19:42:23 GMT
This function is more lenient, and makes the following fuzzy matches:
It permits the following separators between date parts:
space comma period slash dash
It permits the following separators between date and time parts:
space comma period slash dash t
It permits the following separators between time parts:
space period dash colon
It permits date and time parts to not be padded.
It also permits omitting the day of week, time, and timezone parts of
the timestamp.
If ERRORP is true, failing to parse the timestring will signal an
error. Otherwise NIL is returned.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
See PARSE
Parse a timestamp that looks vaguely like an RFC3339 date.
A typical RFC3339 string has the following format:
2023-09-16T10:06:15.00-05:00
This function is more lenient, and makes the following fuzzy matches:
It permits the following separators between date parts:
space comma period slash dash
It permits the following separators between date and time parts:
space dash t
It permits the following separators between time parts:
space period dash colon
It permits date and time parts to not be padded.
It also permits omitting the date and timezone parts of the
timestamp.
If ERRORP is true, failing to parse the timestring will signal an
error. Otherwise NIL is returned.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
See PARSE
Parse a single token.
If it’s an integer, it can denote either:
seconds in the future, if below 1000
a year, if below 5000
a UNIX timestamp
If it’s a word, it can denote either:
a day of the week, pushed to the next week if the current day is
already past.
a month, pushed to the next year if the current month is already
past.
Examples:
10
1900
mon
march
If ERRORP is true, failing to parse the timestring will signal an
error. Otherwise NIL is returned.
If NOW is given it should be a universal-time timestamp that the
parsed timestring will be relative to. If not given, the current time
is used.
See PARSE
Print a universal-time stamp into a print representation.
FORMAT may be one of the following:
:RFC3339 – PRINT-RFC3339
:ISO8661 – PRINT-ISO8661
:REVERSE – PRINT-REVERSE
:RFC1123 – PRINT-RFC1123
:RELATIVE – PRINT-RELATIVE
:DATE – PRINT-DATE
:CLOCK – PRINT-CLOCK
The STREAM and TIME-ZONE are passed along. NOW is only used for the
:RELATIVE format.
See PRINT-RFC3339
See PRINT-ISO8661
See PRINT-REVERSE
See PRINT-RFC1123
See PRINT-RELATIVE
See PRINT-DATE
See PRINT-CLOCK
Print a universal-time as a HH:MM:SS time.
TIME-ZONE may either be a time zone short name string, a time zone
offset as specified by Common Lisp, or NIL for UTC.
If STREAM is NIL, the result is printed to a string and returned. If
STREAM is T, the result is printed to *STANDARD-OUTPUT*.
See PRINT
See PARSE-SINGLE
Print a universal-time as a YYY.MM.DD date.
TIME-ZONE may either be a time zone short name string, a time zone
offset as specified by Common Lisp, or NIL for UTC.
If STREAM is NIL, the result is printed to a string and returned. If
STREAM is T, the result is printed to *STANDARD-OUTPUT*.
See PRINT
See PARSE-SINGLE
Print a universal-time in the ISO8661 format.
TIME-ZONE may either be a time zone short name string, a time zone
offset as specified by Common Lisp, or NIL for UTC.
If STREAM is NIL, the result is printed to a string and returned. If
STREAM is T, the result is printed to *STANDARD-OUTPUT*.
See PRINT
See PARSE-ISO8661-LIKE
Print a universal-time as a relative amount of time.
If NOW is given it should be a universal-time timestamp that the
printed timestring will be relative to. If not given, the current time
is used.
If STREAM is NIL, the result is printed to a string and returned. If
STREAM is T, the result is printed to *STANDARD-OUTPUT*.
See PRINT
See PARSE-FORWARD-TIME
See PARSE-BACKWARD-TIME
Print a universal-time in a format that is "reverse" from the others.
TIME-ZONE may either be a time zone short name string, a time zone
offset as specified by Common Lisp, or NIL for UTC.
If STREAM is NIL, the result is printed to a string and returned. If
STREAM is T, the result is printed to *STANDARD-OUTPUT*.
See PRINT
See PARSE-REVERSE-LIKE
Print a universal-time in the RFC1123 format.
TIME-ZONE may either be a time zone short name string, a time zone
offset as specified by Common Lisp, or NIL for UTC.
If STREAM is NIL, the result is printed to a string and returned. If
STREAM is T, the result is printed to *STANDARD-OUTPUT*.
See PRINT
See PARSE-RFC1123-LIKE
Print a universal-time in the RFC3339 format.
TIME-ZONE may either be a time zone short name string, a time zone
offset as specified by Common Lisp, or NIL for UTC.
If STREAM is NIL, the result is printed to a string and returned. If
STREAM is T, the result is printed to *STANDARD-OUTPUT*.
See PRINT
See PARSE-RFC3339-LIKE
| Jump to: | B C D E F M P W |
|---|
| Jump to: | B C D E F M P W |
|---|
| Jump to: | *
S |
|---|
| Index Entry | Section | ||
|---|---|---|---|
| | |||
| * | |||
*tzdb*: | Private special variables | ||
| | |||
| S | |||
Special Variable, *tzdb*: | Private special variables | ||
| | |||
| Jump to: | *
S |
|---|
| Jump to: | D F O P S |
|---|
| Jump to: | D F O P S |
|---|