This is the periods Reference Manual, version 0.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Fri Sep 15 06:15:07 2023 GMT+0.
The main system appears first, followed by any subsystem dependency.
periodsUtilities for manipulating time ranges and distances, based on LOCAL-TIME.
Christophe Junke <junke.christophe@gmail.com>
Johh Wiegley <jwiegley@gmail.com>
BSD-3
0.0.2
local-time (system).
periods.lisp (file).
strptime.lisp (file).
parser.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
periods/periods.lispperiods (system).
*input-time-format* (special variable).
*output-time-format* (special variable).
add-duration (function).
add-time (function).
current-year (function).
day-of-week (function).
duration (function).
duration (structure).
duration-seconds (reader).
(setf duration-seconds) (writer).
falls-on-weekend-p (function).
find-smallest-resolution (function).
fixed-time (function).
fixed-time (type).
floor-time (function).
leapp (function).
sleep-until (function).
subtract-duration (function).
subtract-time (function).
time-difference (function).
time-period (function).
time-period (structure).
time-period-generator (function).
time-range (function).
time-range (structure).
(setf time-range-begin) (setf expander).
time-range-begin (function).
time-range-duration (function).
time-range-end (function).
time-within-range-p (function).
with-timestamp-range (macro).
*days-in-months* (special variable).
add-days (function).
add-hours (function).
add-microseconds (function).
add-milliseconds (function).
add-minutes (function).
add-months (function).
add-nanoseconds (function).
add-seconds (function).
add-years (function).
bounded-add (function).
bounded-subtract (function).
copy-duration (function).
copy-relative-time (function).
copy-time-period (function).
copy-time-range (function).
day-begin (function).
day-end (function).
day-of (function).
day-range (function).
days-in-month (function).
details-match-relative-time-p (function).
do-relative-times (macro).
do-time-period (macro).
do-times (macro).
duration-days (reader).
(setf duration-days) (writer).
duration-hours (reader).
(setf duration-hours) (writer).
duration-microseconds (reader).
(setf duration-microseconds) (writer).
duration-milliseconds (reader).
(setf duration-milliseconds) (writer).
duration-minutes (reader).
(setf duration-minutes) (writer).
duration-months (reader).
(setf duration-months) (writer).
duration-nanoseconds (reader).
(setf duration-nanoseconds) (writer).
duration-p (function).
duration-years (reader).
(setf duration-years) (writer).
enclosing-duration (function).
get-range-anchor (reader).
(setf get-range-anchor) (writer).
get-range-begin (reader).
(setf get-range-begin) (writer).
get-range-begin-inclusive-p (reader).
(setf get-range-begin-inclusive-p) (writer).
get-range-duration (reader).
(setf get-range-duration) (writer).
get-range-end (reader).
(setf get-range-end) (writer).
get-range-end-inclusive-p (reader).
(setf get-range-end-inclusive-p) (writer).
get-range-fixed-begin (reader).
(setf get-range-fixed-begin) (writer).
get-range-fixed-end (reader).
(setf get-range-fixed-end) (writer).
hour-begin (function).
hour-end (function).
hour-of (function).
hour-range (function).
list-relative-times (macro).
list-time-period (macro).
list-times (macro).
loop-relative-times (macro).
loop-time-period (macro).
loop-times (macro).
make-duration (function).
make-relative-time (function).
make-time-period (function).
make-time-range (function).
map-relative-times (macro).
map-time-period (macro).
map-times (macro).
matches-relative-time-p (function).
microsecond-begin (function).
microsecond-end (function).
microsecond-of (function).
microsecond-part (function).
millisecond-begin (function).
millisecond-end (function).
millisecond-of (function).
millisecond-part (function).
minute-begin (function).
minute-end (function).
minute-of (function).
minute-range (function).
monday-week-begin (function).
monday-week-end (function).
monday-week-range (function).
month-begin (function).
month-end (function).
month-of (function).
month-range (function).
multiply-duration (function).
nanosecond-of (function).
nanosecond-part (function).
next-day (function).
next-friday (function).
next-hour (function).
next-microsecond (function).
next-millisecond (function).
next-minute (function).
next-monday (function).
next-monday-week (function).
next-month (function).
next-saturday (function).
next-second (function).
next-sunday (function).
next-sunday-week (function).
next-thursday (function).
next-time (function).
next-tuesday (function).
next-wednesday (function).
next-year (function).
previous-day (function).
previous-friday (function).
previous-hour (function).
previous-millisecond (function).
previous-minute (function).
previous-monday (function).
previous-monday-week (function).
previous-month (function).
previous-nanosecond (function).
previous-saturday (function).
previous-second (function).
previous-sunday (function).
previous-sunday-week (function).
previous-thursday (function).
previous-time (function).
previous-tuesday (function).
previous-wednesday (function).
previous-year (function).
range-dec (function).
range-inc (function).
relative-time (function).
relative-time (structure).
relative-time-day (reader).
(setf relative-time-day) (writer).
relative-time-day-of-week (reader).
(setf relative-time-day-of-week) (writer).
relative-time-generator (function).
relative-time-hour (reader).
(setf relative-time-hour) (writer).
relative-time-microsecond (reader).
(setf relative-time-microsecond) (writer).
relative-time-millisecond (reader).
(setf relative-time-millisecond) (writer).
relative-time-minute (reader).
(setf relative-time-minute) (writer).
relative-time-month (reader).
(setf relative-time-month) (writer).
relative-time-nanosecond (reader).
(setf relative-time-nanosecond) (writer).
relative-time-p (function).
relative-time-second (reader).
(setf relative-time-second) (writer).
relative-time-stepper (function).
relative-time-week (reader).
(setf relative-time-week) (writer).
relative-time-year (reader).
(setf relative-time-year) (writer).
second-begin (function).
second-end (function).
second-of (function).
second-range (function).
set-microsecond-part (function).
set-millisecond-part (function).
set-nanosecond-part (function).
subtract-days (function).
subtract-hours (function).
subtract-microseconds (function).
subtract-milliseconds (function).
subtract-minutes (function).
subtract-months (function).
subtract-nanoseconds (function).
subtract-seconds (function).
subtract-years (function).
sunday-week-begin (function).
sunday-week-end (function).
sunday-week-range (function).
this-day (function).
this-day-range (function).
this-friday (function).
this-hour (function).
this-hour-range (function).
this-microsecond (function).
this-millisecond (function).
this-minute (function).
this-minute-range (function).
this-monday (function).
this-monday-week (function).
this-monday-week-range (function).
this-month (function).
this-month-range (function).
this-saturday (function).
this-second (function).
this-second-range (function).
this-sunday (function).
this-sunday-week (function).
this-sunday-week-range (function).
this-thursday (function).
this-tuesday (function).
this-wednesday (function).
this-year (function).
this-year-range (function).
time-generator (function).
time-period-begin (function).
time-period-end (function).
time-period-p (function).
time-period-range (reader).
(setf time-period-range) (writer).
time-period-skip (reader).
(setf time-period-skip) (writer).
time-period-step (reader).
(setf time-period-step) (writer).
time-range-anchor (function).
time-range-begin-inclusive-p (function).
time-range-end-inclusive-p (function).
time-range-next (function).
time-range-p (function).
time-range-previous (function).
time-stepper (function).
time-within-begin-end-p (function).
with-skippers (macro).
year-begin (function).
year-end (function).
year-of (function).
year-range (function).
periods/strptime.lispperiods.lisp (file).
periods (system).
read-fixed-time (function).
strftime (function).
strptime (function).
strptime-decoded (function).
read-integer (function).
periods/parser.lispstrptime.lisp (file).
periods (system).
parse-time-period (function).
parse-time-range (function).
*parser-readtable* (special variable).
*token-stack* (special variable).
compile-duration (function).
compile-relative-time (function).
compile-time (function).
if-let (macro).
ignore-character (function).
make-duration-relative (function).
p/cardinal (function).
p/days-of-week (function).
p/duration-spec (function).
p/fixed-time (function).
p/months-of-year (function).
p/number (function).
p/ordinal (function).
p/period-unit (function).
p/qualified-time (function).
p/relative-time (function).
p/time (function).
p/time-duration (function).
p/time-reference (function).
p/time-unit (function).
peek-token (function).
read-from-stream (function).
read-token (function).
time-parser-tests (function).
unread-token (function).
Packages are listed by definition order.
periodstime-periods
common-lisp.
local-time.
*input-time-format* (special variable).
*output-time-format* (special variable).
add-duration (function).
add-time (function).
current-year (function).
day-of-week (function).
duration (function).
duration (structure).
duration-seconds (reader).
(setf duration-seconds) (writer).
falls-on-weekend-p (function).
find-smallest-resolution (function).
fixed-time (function).
fixed-time (type).
floor-time (function).
leapp (function).
parse-time-period (function).
parse-time-range (function).
read-fixed-time (function).
sleep-until (function).
strftime (function).
strptime (function).
strptime-decoded (function).
subtract-duration (function).
subtract-time (function).
time-difference (function).
time-period (function).
time-period (structure).
time-period-generator (function).
time-range (function).
time-range (structure).
(setf time-range-begin) (setf expander).
time-range-begin (function).
time-range-duration (function).
time-range-end (function).
time-within-range-p (function).
with-timestamp-range (macro).
*days-in-months* (special variable).
*parser-readtable* (special variable).
*token-stack* (special variable).
add-days (function).
add-hours (function).
add-microseconds (function).
add-milliseconds (function).
add-minutes (function).
add-months (function).
add-nanoseconds (function).
add-seconds (function).
add-years (function).
bounded-add (function).
bounded-subtract (function).
compile-duration (function).
compile-relative-time (function).
compile-time (function).
copy-duration (function).
copy-relative-time (function).
copy-time-period (function).
copy-time-range (function).
day-begin (function).
day-end (function).
day-of (function).
day-range (function).
days-in-month (function).
details-match-relative-time-p (function).
do-relative-times (macro).
do-time-period (macro).
do-times (macro).
duration-days (reader).
(setf duration-days) (writer).
duration-hours (reader).
(setf duration-hours) (writer).
duration-microseconds (reader).
(setf duration-microseconds) (writer).
duration-milliseconds (reader).
(setf duration-milliseconds) (writer).
duration-minutes (reader).
(setf duration-minutes) (writer).
duration-months (reader).
(setf duration-months) (writer).
duration-nanoseconds (reader).
(setf duration-nanoseconds) (writer).
duration-p (function).
duration-years (reader).
(setf duration-years) (writer).
enclosing-duration (function).
get-range-anchor (reader).
(setf get-range-anchor) (writer).
get-range-begin (reader).
(setf get-range-begin) (writer).
get-range-begin-inclusive-p (reader).
(setf get-range-begin-inclusive-p) (writer).
get-range-duration (reader).
(setf get-range-duration) (writer).
get-range-end (reader).
(setf get-range-end) (writer).
get-range-end-inclusive-p (reader).
(setf get-range-end-inclusive-p) (writer).
get-range-fixed-begin (reader).
(setf get-range-fixed-begin) (writer).
get-range-fixed-end (reader).
(setf get-range-fixed-end) (writer).
hour-begin (function).
hour-end (function).
hour-of (function).
hour-range (function).
if-let (macro).
ignore-character (function).
list-relative-times (macro).
list-time-period (macro).
list-times (macro).
loop-relative-times (macro).
loop-time-period (macro).
loop-times (macro).
make-duration (function).
make-duration-relative (function).
make-relative-time (function).
make-time-period (function).
make-time-range (function).
map-relative-times (macro).
map-time-period (macro).
map-times (macro).
matches-relative-time-p (function).
microsecond-begin (function).
microsecond-end (function).
microsecond-of (function).
microsecond-part (function).
millisecond-begin (function).
millisecond-end (function).
millisecond-of (function).
millisecond-part (function).
minute-begin (function).
minute-end (function).
minute-of (function).
minute-range (function).
monday-week-begin (function).
monday-week-end (function).
monday-week-range (function).
month-begin (function).
month-end (function).
month-of (function).
month-range (function).
multiply-duration (function).
nanosecond-of (function).
nanosecond-part (function).
next-day (function).
next-friday (function).
next-hour (function).
next-microsecond (function).
next-millisecond (function).
next-minute (function).
next-monday (function).
next-monday-week (function).
next-month (function).
next-saturday (function).
next-second (function).
next-sunday (function).
next-sunday-week (function).
next-thursday (function).
next-time (function).
next-tuesday (function).
next-wednesday (function).
next-year (function).
p/cardinal (function).
p/days-of-week (function).
p/duration-spec (function).
p/fixed-time (function).
p/months-of-year (function).
p/number (function).
p/ordinal (function).
p/period-unit (function).
p/qualified-time (function).
p/relative-time (function).
p/time (function).
p/time-duration (function).
p/time-reference (function).
p/time-unit (function).
peek-token (function).
previous-day (function).
previous-friday (function).
previous-hour (function).
previous-millisecond (function).
previous-minute (function).
previous-monday (function).
previous-monday-week (function).
previous-month (function).
previous-nanosecond (function).
previous-saturday (function).
previous-second (function).
previous-sunday (function).
previous-sunday-week (function).
previous-thursday (function).
previous-time (function).
previous-tuesday (function).
previous-wednesday (function).
previous-year (function).
range-dec (function).
range-inc (function).
read-from-stream (function).
read-integer (function).
read-token (function).
relative-time (function).
relative-time (structure).
relative-time-day (reader).
(setf relative-time-day) (writer).
relative-time-day-of-week (reader).
(setf relative-time-day-of-week) (writer).
relative-time-generator (function).
relative-time-hour (reader).
(setf relative-time-hour) (writer).
relative-time-microsecond (reader).
(setf relative-time-microsecond) (writer).
relative-time-millisecond (reader).
(setf relative-time-millisecond) (writer).
relative-time-minute (reader).
(setf relative-time-minute) (writer).
relative-time-month (reader).
(setf relative-time-month) (writer).
relative-time-nanosecond (reader).
(setf relative-time-nanosecond) (writer).
relative-time-p (function).
relative-time-second (reader).
(setf relative-time-second) (writer).
relative-time-stepper (function).
relative-time-week (reader).
(setf relative-time-week) (writer).
relative-time-year (reader).
(setf relative-time-year) (writer).
second-begin (function).
second-end (function).
second-of (function).
second-range (function).
set-microsecond-part (function).
set-millisecond-part (function).
set-nanosecond-part (function).
subtract-days (function).
subtract-hours (function).
subtract-microseconds (function).
subtract-milliseconds (function).
subtract-minutes (function).
subtract-months (function).
subtract-nanoseconds (function).
subtract-seconds (function).
subtract-years (function).
sunday-week-begin (function).
sunday-week-end (function).
sunday-week-range (function).
this-day (function).
this-day-range (function).
this-friday (function).
this-hour (function).
this-hour-range (function).
this-microsecond (function).
this-millisecond (function).
this-minute (function).
this-minute-range (function).
this-monday (function).
this-monday-week (function).
this-monday-week-range (function).
this-month (function).
this-month-range (function).
this-saturday (function).
this-second (function).
this-second-range (function).
this-sunday (function).
this-sunday-week (function).
this-sunday-week-range (function).
this-thursday (function).
this-tuesday (function).
this-wednesday (function).
this-year (function).
this-year-range (function).
time-generator (function).
time-parser-tests (function).
time-period-begin (function).
time-period-end (function).
time-period-p (function).
time-period-range (reader).
(setf time-period-range) (writer).
time-period-skip (reader).
(setf time-period-skip) (writer).
time-period-step (reader).
(setf time-period-step) (writer).
time-range-anchor (function).
time-range-begin-inclusive-p (function).
time-range-end-inclusive-p (function).
time-range-next (function).
time-range-p (function).
time-range-previous (function).
time-stepper (function).
time-within-begin-end-p (function).
unread-token (function).
with-skippers (macro).
year-begin (function).
year-end (function).
year-of (function).
year-range (function).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Define a context where (1) MIN-SYMBOL and MAX-SYMBOL are locally
bound variables with NIL default values and (2) UPDATE names a
lexically bound function which takes a timestamp and updates the
variables MIN-SYMBOL and MAX-SYMBOL so that they respectively hold the
earliest and latest timestamp after successive invocations. That
function finally returns its input value. For example, the following
code builds a TIME-RANGE instance from a list of dated transactions.
(with-timestamp-range (earliest latest)
(dolist (tt transaction)
(update-range (transaction-date tt)))
(time-range :begin earliest :end latest :end-inclusive-p t))
A custom name can be used to nest invocations:
(with-timestamp-range (earliest latest global-update-range)
(dolist (jj journals)
(with-timestamp-range (<< >>)
(dolist (tt (journal-xact jj))
(gloal-update-range
(update-range (transaction-date tt))))
(format t "Journal earliest / latest: ~A / ~A~%" << >>)))
(format t "Global earliest / latest: ~A / ~A~%" earliest latest))
Add one duration to another.
Given a FIXED-TIME, add the supplied DURATION.
Example (reader notation requires calling LOCAL-TIME:ENABLE-READ-MACROS):
(add-time @2007-05-20T12:10:10.000 (duration :hours 50))
=> @2007-05-22T14:10:10.000
NOTE: This function always adds the largest increments first, so:
(add-time @2003-01-09 (duration :years 1 :days 20)) => @2004-02-29
If days has been added before years, the result would have been "@2004-03-01".
Return the current year as a FIXNUM.
Return the day of the week associated with a given FIXED-TIME.
The result is a FIXNUM with 0 representing Sunday, through 6 on Saturday.
Create a DURATION object.
One thing to note about duration: there is no way to determine the total length of a duration in terms of any specific time quantity, without first binding that duration to a fixed point in time (after all, how many days are in a month if you don’t know which month it is?) Therefore, those looking for a function like "duration-seconds" are really wanting to work with ranges, not just durations.
Return T if the given FIXED-TIME occurs on a Saturday or Sunday.
Examine the property list STEP-BY and return the smallest unit of time
specified.
For example, given the following property list:
(:DAY 10 :HOUR 5 :MINUTE 2)
The result is :MINUTE.
Return a fixed point in time relative to the time of the call. ARGS is a
property list giving a specific precision for the return value.
If the keyword argument :NOW is given, all else is ignored; this is
equivalent to calling LOCAL-TIME:NOW.
Otherwise, any keyword arguments given override their corresponding elements in the current time. Further, any elements smaller in resolution than the finest specified element are reduced to 0 or 1, according to their position.
For example, assuming the current time is "@2007-11-17T23:02:00.000",
compare these outputs:
(fixed-time :month 4) => @2007-04-01T00:00:00.000
(fixed-time :day 10) => @2007-11-10T00:00:00.000
(fixed-time :hour 15) => @2007-11-17T15:00:00.000
This behavior makes it very easy to return a fixed time for "april of this year", etc. If you wish to determine the date of the previous April, while preserving the current day of the month, hour of the day, etc., then see the function PREVIOUS-TIME.
Reduce a fixed time to be no finer than RESOLUTION.
For example, if the date is 2007-04-20, and the resolution is :month, the date is floored to 2007-04-01. Anything smaller than the resolution is reduced to zero (or 1, if it is a day or month being reduced).
Return T if YEAR falls on a leap year.
Subtract one duration from another.
Compute the duration existing between fixed-times LEFT and RIGHT.
The order of left or right is ignored; the returned DURATION, if added to
the earlier value, will result in the later.
A complexity of this process which might surprise some is that larger quantities are added by ADD-TIME before smaller quantities. For example, what is the difference between 2003-02-10 and 2004-03-01? If you add years before days, the difference is 1 year and 20 days. If you were to add days before years, however, the difference would be 1 year and 21 days. The question, do you advance to 2004 and then calculate between 2-10 and 3-01, or do you move from 2-10 to 3-01, and then increment the year? This library chooses to add years before days, since this follows human reckoning a bit closer (i.e., a person would likely flip to the 2004 calendar and then start counting off days, rather than the other way around). This difference in reckoning can be tricky, however, so bear this in mind.
structure-object.
integer
0
integer
0
integer
0
integer
0
integer
0
integer
0
integer
0
integer
0
integer
0
structure-object.
t
A ’do’ style version of the functional MAP-RELATIVE-TIMES macro.
The disadvantage to DO-RELATIVE-TIMES is that there is no way to ask for a reversed time sequence, or specify an inclusive endpoint.
A ’do’ style version of the functional MAP-TIMES macro.
The disadvantage to DO-TIMES is that there is no way to ask for a reversed time sequence, or specify an inclusive endpoint.
Return a list of all times within the given range.
Return a list of all times within the given range.
Map over a set of times separated by DURATION, calling CALLABLE with the start of each.
Map over a set of times separated by DURATION, calling CALLABLE with the start of each.
Map over a set of times separated by DURATION, calling CALLABLE with the start of each.
A bounded addition operator. Returns: VALUE CARRY.
A bounded subtraction operator. Returns: VALUE CARRY.
Return T if the given time elements honor the details in RELATIVE-TIME.
days.
Return a DURATION which, if applied to a time, causes NEXT-TIME to move to
the next matching occurrence of that time pattern.
For example, if you ask for ’:day 18’ on Nov 18, it will return the same time back to you. If you add enclosing duration for that relative time to Nov 18 and then ask again, you’ll get Dec 18.
end.
Return T if the given FIXED-TIME honors the details in RELATIVE-TIME.
Add one duration to another.
Compute the first time after FIXED-TIME which matches RELATIVE-TIME.
This function finds the first moment after FIXED-TIME which honors every
element in RELATIVE-TIME:
(next-time @2007-05-20 (relative-time :month 3)) => @2008-03-20
The relative time constructor arguments may also be symbolic:
(relative-time :month :this)
(relative-time :month :next)
(relative-time :month :prev)
To find the date two weeks after next February, a combination of NEXT-TIME
and ADD-TIME must be used, since "next February" is a relative time concept,
while "two weeks" is a duration concept:
(add-time (next-time @2007-05-20 (relative-time :month 2))
(duration :days 14))
NOTE: The keyword arguments to RELATIVE-TIME are always singular; those to
DURATION are always plural.
The following form resolves to the first sunday of the given year:
(next-time (previous-time @2007-05-20
(relative-time :month 1 :day 1))
(relative-time :week-day 0))
This form finds the first Friday the 13th after today:
(next-time @2007-05-20 (relative-time :day 13 :day-of-week 5))
NOTE: When adding times, NEXT-TIME always seeks the next time that fully
honors your request. If asked for Feb 29, the year of the resulting time will
fall in a leap year. If asked for Thu, Apr 29, it returns the next occurrence
of Apr 29 which falls on a Friday. Example:
(next-time @2007-11-01
(relative-time :month 4 :day 29 :day-of-week 4))
=> @2010-04-29T00:00:00.000
This function is the reverse of ‘NEXT-TIME’. Please look there for more.
day.
hour.
week.
year.
skip.
step.
structure-object.
(or keyword integer null)
(or keyword integer null)
(or keyword integer null)
(or keyword integer null)
(or keyword integer null)
(or keyword integer null)
(or keyword integer null)
common-lisp.
(or keyword integer null)
(or keyword integer null)
(or keyword integer null)
(or keyword integer null)
| Jump to: | (
A B C D E F G H I L M N P R S T U W Y |
|---|
| Jump to: | (
A B C D E F G H I L M N P R S T U W Y |
|---|
| Jump to: | *
A B D E F H M N R S W Y |
|---|
| Jump to: | *
A B D E F H M N R S W Y |
|---|
| Jump to: | D F P R S T |
|---|
| Jump to: | D F P R S T |
|---|