The net-telent-date Reference Manual

Table of Contents

Next: , Previous: , Up: (dir)   [Contents][Index]

The net-telent-date Reference Manual

This is the net-telent-date Reference Manual, version 0.41, generated automatically by Declt version 2.4 "Will Decker" on Wed Jun 20 12:19:28 2018 GMT+0.


Next: , Previous: , Up: Top   [Contents][Index]

1 Introduction

Most of the code in this package is parse-time.lisp, which was
originally written by Jim Healy in June 1987, and has been lifted
wholesale from CMUCL.

The rest of it is a few useful functions for printing dates in
standard(sic) formats.  See documentation strings for
universal-time-to-http-date, universal-time-to-rfc2822-date, dayname,
monthname.

Thanks to Kevin Rosenberg for bouncing ideas off, for the initial
universal-time-to-rfc2822-date implementation, and for Debian
packaging



Next: , Previous: , Up: Top   [Contents][Index]

2 Systems

The main system appears first, followed by any subsystem dependency.


Previous: , Up: Systems   [Contents][Index]

2.1 net-telent-date

Version

0.41

Source

net-telent-date.asd (file)

Components

Next: , Previous: , Up: Top   [Contents][Index]

3 Files

Files are sorted by type and then listed depth-first from the systems components trees.


Previous: , Up: Files   [Contents][Index]

3.1 Lisp


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.1 net-telent-date.asd

Location

net-telent-date.asd

Systems

net-telent-date (system)

Packages

net-telent-date-system


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.2 net-telent-date/defpackage.lisp

Parent

net-telent-date (system)

Location

defpackage.lisp

Packages

net.telent.date


Next: , Previous: , Up: Lisp files   [Contents][Index]

3.1.3 net-telent-date/date.lisp

Dependency

defpackage.lisp (file)

Parent

net-telent-date (system)

Location

date.lisp

Exported Definitions
Internal Definitions

Previous: , Up: Lisp files   [Contents][Index]

3.1.4 net-telent-date/parse-time.lisp

Dependency

defpackage.lisp (file)

Parent

net-telent-date (system)

Location

parse-time.lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

4 Packages

Packages are listed by definition order.


Next: , Previous: , Up: Packages   [Contents][Index]

4.1 net-telent-date-system

Source

net-telent-date.asd

Use List

Previous: , Up: Packages   [Contents][Index]

4.2 net.telent.date

Source

defpackage.lisp (file)

Nickname

date

Use List

common-lisp

Exported Definitions
Internal Definitions

Next: , Previous: , Up: Top   [Contents][Index]

5 Definitions

Definitions are sorted by export status, category, package, and then by lexicographic order.


Next: , Previous: , Up: Definitions   [Contents][Index]

5.1 Exported definitions


Next: , Previous: , Up: Exported definitions   [Contents][Index]

5.1.1 Macros

Macro: with-date UTIME ZONE &body BODY

UTIME is a universal-time, ZONE is a number of hours offset from UTC, or NIL to use local time. Execute BODY in an environment where SECOND MINUTE HOUR DAY-OF-MONTH MONTH YEAR DAY-OF-WEEK DAYLIGHT-P ZONE are bound to the decoded components of the universal time

Package

net.telent.date

Source

date.lisp (file)

Macro: with-decoding (UTIME &optional ZONE) &body BODY

UTIME is a universal-time, ZONE is a number of hours offset from UTC, or NIL to use local time. Execute BODY in an environment where SECOND MINUTE HOUR DAY-OF-MONTH MONTH YEAR DAY-OF-WEEK DAYLIGHT-P ZONE are bound to the decoded components of the universal time

Package

net.telent.date

Source

date.lisp (file)


Previous: , Up: Exported definitions   [Contents][Index]

5.1.2 Functions

Function: dayname STREAM ARG COLON-P AT-P &optional WIDTH MINCOL COLINC MINPAD PADCHAR

Print the day of the week (0=Sunday) corresponding to ARG on STREAM. This is intended for embedding in a FORMAT directive: WIDTH governs the number of characters of text printed, MINCOL, COLINC, MINPAD, PADCHAR work as for ~A

Package

net.telent.date

Source

date.lisp (file)

Function: decode-universal-time/plist UTIME &optional ZONE
Package

net.telent.date

Source

date.lisp (file)

Function: hour NUMBER
Package

net.telent.date

Source

parse-time.lisp (file)

Function: minute NUMBER
Package

net.telent.date

Source

parse-time.lisp (file)

Function: month THING
Package

net.telent.date

Source

parse-time.lisp (file)

Function: monthname STREAM ARG COLON-P AT-P &optional WIDTH MINCOL COLINC MINPAD PADCHAR

Print the name of the month (1=January) corresponding to ARG on STREAM. This is intended for embedding in a FORMAT directive: WIDTH governs the number of characters of text printed, MINCOL, COLINC, MINPAD, PADCHAR work as for ~A

Package

net.telent.date

Source

date.lisp (file)

Function: parse-time TIME-STRING &key START END ERROR-ON-MISMATCH PATTERNS DEFAULT-SECONDS DEFAULT-MINUTES DEFAULT-HOURS DEFAULT-DAY DEFAULT-MONTH DEFAULT-YEAR DEFAULT-ZONE DEFAULT-WEEKDAY

Tries very hard to make sense out of the argument time-string and returns a single integer representing the universal time if successful. If not, it returns nil. If the :error-on-mismatch keyword is true, parse-time will signal an error instead of returning nil. Default values for each part of the time/date can be specified by the appropriate :default- keyword. These keywords can be given a numeric value or the keyword :current to set them to the current value. The default-default values are 00:00:00 on the current date, current time-zone.

Package

net.telent.date

Source

parse-time.lisp (file)

Function: universal-time-to-http-date UTIME

Decode the universal time UTIME and return a date suitable for use in HTTP 1.0 applications (RFC-822, but GMT)

Package

net.telent.date

Source

date.lisp (file)

Function: universal-time-to-rfc-date UTIME

Decode the universal time UTIME and return a date suitable for use in HTTP 1.0 applications (RFC-822, but GMT)

Package

net.telent.date

Source

date.lisp (file)

Function: universal-time-to-rfc2822-date UTIME &optional TIME-ZONE

Decode the universal time UTIME and return an RFC-2822-format string. TIME-ZONE is a CL time zone. If not supplied, it defaults to the current time zone adjusted for daylight saving time. If TIME-ZONE is supplied, daylight saving time information is ignored.

Package

net.telent.date

Source

date.lisp (file)

Function: year NUMBER
Package

net.telent.date

Source

parse-time.lisp (file)

Function: zone THING
Package

net.telent.date

Source

parse-time.lisp (file)


Previous: , Up: Definitions   [Contents][Index]

5.2 Internal definitions


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.1 Special variables

Special Variable: *day-names*
Package

net.telent.date

Source

date.lisp (file)

Special Variable: *default-date-time-patterns*
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: *error-on-mismatch*

If t, an error will be signalled if parse-time is unable to determine the time/date format of the string.

Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: *http-date-time-patterns*
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: *month-names*
Package

net.telent.date

Source

date.lisp (file)

Special Variable: *month-strings*
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: *special-strings*
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: *weekday-strings*
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: *zone-strings*
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: date-dividers
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: month-table-size
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: special-table-size
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: time-dividers
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: weekday-table-size
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: whitespace-chars
Package

net.telent.date

Source

parse-time.lisp (file)

Special Variable: zone-table-size
Package

net.telent.date

Source

parse-time.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.2 Macros

Macro: hashlist LIST TABLE
Package

net.telent.date

Source

parse-time.lisp (file)


Next: , Previous: , Up: Internal definitions   [Contents][Index]

5.2.3 Functions

Function: am-pm STRING
Package

net.telent.date

Source

parse-time.lisp (file)

Function: convert-to-unitime PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)

Function: copy-decoded-time INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: date-divider CHARACTER
Package

net.telent.date

Source

parse-time.lisp (file)

Function: day NUMBER
Package

net.telent.date

Source

parse-time.lisp (file)

Function: deal-with-am-pm FORM-VALUE PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)

Function: deal-with-izone FORM-VALUE PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)

Function: deal-with-noon-midn FORM-VALUE PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-day INSTANCE
Function: (setf decoded-time-day) VALUE INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-dotw INSTANCE
Function: (setf decoded-time-dotw) VALUE INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-hour INSTANCE
Function: (setf decoded-time-hour) VALUE INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-minute INSTANCE
Function: (setf decoded-time-minute) VALUE INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-month INSTANCE
Function: (setf decoded-time-month) VALUE INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-p OBJECT
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-second INSTANCE
Function: (setf decoded-time-second) VALUE INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-year INSTANCE
Function: (setf decoded-time-year) VALUE INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decoded-time-zone INSTANCE
Function: (setf decoded-time-zone) VALUE INSTANCE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: decompose-string STRING &key START END RADIX
Package

net.telent.date

Source

parse-time.lisp (file)

Function: izone THING
Package

net.telent.date

Source

parse-time.lisp (file)

Function: make-decoded-time &key (SECOND SECOND) (MINUTE MINUTE) (HOUR HOUR) (DAY DAY) (MONTH MONTH) (YEAR YEAR) (ZONE ZONE) (DOTW DOTW)
Package

net.telent.date

Source

parse-time.lisp (file)

Function: make-default-time DEF-SEC DEF-MIN DEF-HOUR DEF-DAY DEF-MON DEF-YEAR DEF-ZONE DEF-DOTW
Package

net.telent.date

Source

parse-time.lisp (file)

Function: match-pattern PATTERN DATUM DATUM-LENGTH
Package

net.telent.date

Source

parse-time.lisp (file)

Function: match-pattern-element PATTERN-ELEMENT DATUM-ELEMENT
Package

net.telent.date

Source

parse-time.lisp (file)

Function: match-substring SUBSTRING
Package

net.telent.date

Source

parse-time.lisp (file)

Function: noon-midn STRING
Package

net.telent.date

Source

parse-time.lisp (file)

Function: now PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)

Function: secondp NUMBER
Package

net.telent.date

Source

parse-time.lisp (file)

Function: set-current-value VALUES-STRUCTURE &key TIME DATE ZONE
Package

net.telent.date

Source

parse-time.lisp (file)

Function: set-time-values STRING-FORM PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)

Function: special-string-p STRING
Package

net.telent.date

Source

parse-time.lisp (file)

Function: time-divider CHARACTER
Package

net.telent.date

Source

parse-time.lisp (file)

Function: today PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)

Function: tomorrow PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)

Function: weekday STRING
Package

net.telent.date

Source

parse-time.lisp (file)

Function: yesterday PARSED-VALUES
Package

net.telent.date

Source

parse-time.lisp (file)


Previous: , Up: Internal definitions   [Contents][Index]

5.2.4 Structures

Structure: decoded-time ()
Package

net.telent.date

Source

parse-time.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: second
Type

integer

Initform

0

Readers

decoded-time-second (function)

Writers

(setf decoded-time-second) (function)

Slot: minute
Type

integer

Initform

0

Readers

decoded-time-minute (function)

Writers

(setf decoded-time-minute) (function)

Slot: hour
Type

integer

Initform

0

Readers

decoded-time-hour (function)

Writers

(setf decoded-time-hour) (function)

Slot: day
Type

integer

Initform

1

Readers

decoded-time-day (function)

Writers

(setf decoded-time-day) (function)

Slot: month
Type

integer

Initform

1

Readers

decoded-time-month (function)

Writers

(setf decoded-time-month) (function)

Slot: year
Type

integer

Initform

1900

Readers

decoded-time-year (function)

Writers

(setf decoded-time-year) (function)

Slot: zone
Type

rational

Initform

0

Readers

decoded-time-zone (function)

Writers

(setf decoded-time-zone) (function)

Slot: dotw
Type

integer

Initform

0

Readers

decoded-time-dotw (function)

Writers

(setf decoded-time-dotw) (function)


Previous: , Up: Top   [Contents][Index]

Appendix A Indexes


Next: , Previous: , Up: Indexes   [Contents][Index]

A.1 Concepts

Jump to:   F   L   N  
Index Entry  Section

F
File, Lisp, net-telent-date.asd: The net-telent-date<dot>asd file
File, Lisp, net-telent-date/date.lisp: The net-telent-date/date<dot>lisp file
File, Lisp, net-telent-date/defpackage.lisp: The net-telent-date/defpackage<dot>lisp file
File, Lisp, net-telent-date/parse-time.lisp: The net-telent-date/parse-time<dot>lisp file

L
Lisp File, net-telent-date.asd: The net-telent-date<dot>asd file
Lisp File, net-telent-date/date.lisp: The net-telent-date/date<dot>lisp file
Lisp File, net-telent-date/defpackage.lisp: The net-telent-date/defpackage<dot>lisp file
Lisp File, net-telent-date/parse-time.lisp: The net-telent-date/parse-time<dot>lisp file

N
net-telent-date.asd: The net-telent-date<dot>asd file
net-telent-date/date.lisp: The net-telent-date/date<dot>lisp file
net-telent-date/defpackage.lisp: The net-telent-date/defpackage<dot>lisp file
net-telent-date/parse-time.lisp: The net-telent-date/parse-time<dot>lisp file

Jump to:   F   L   N  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.2 Functions

Jump to:   (  
A   C   D   F   H   I   M   N   P   S   T   U   W   Y   Z  
Index Entry  Section

(
(setf decoded-time-day): Internal functions
(setf decoded-time-dotw): Internal functions
(setf decoded-time-hour): Internal functions
(setf decoded-time-minute): Internal functions
(setf decoded-time-month): Internal functions
(setf decoded-time-second): Internal functions
(setf decoded-time-year): Internal functions
(setf decoded-time-zone): Internal functions

A
am-pm: Internal functions

C
convert-to-unitime: Internal functions
copy-decoded-time: Internal functions

D
date-divider: Internal functions
day: Internal functions
dayname: Exported functions
deal-with-am-pm: Internal functions
deal-with-izone: Internal functions
deal-with-noon-midn: Internal functions
decode-universal-time/plist: Exported functions
decoded-time-day: Internal functions
decoded-time-dotw: Internal functions
decoded-time-hour: Internal functions
decoded-time-minute: Internal functions
decoded-time-month: Internal functions
decoded-time-p: Internal functions
decoded-time-second: Internal functions
decoded-time-year: Internal functions
decoded-time-zone: Internal functions
decompose-string: Internal functions

F
Function, (setf decoded-time-day): Internal functions
Function, (setf decoded-time-dotw): Internal functions
Function, (setf decoded-time-hour): Internal functions
Function, (setf decoded-time-minute): Internal functions
Function, (setf decoded-time-month): Internal functions
Function, (setf decoded-time-second): Internal functions
Function, (setf decoded-time-year): Internal functions
Function, (setf decoded-time-zone): Internal functions
Function, am-pm: Internal functions
Function, convert-to-unitime: Internal functions
Function, copy-decoded-time: Internal functions
Function, date-divider: Internal functions
Function, day: Internal functions
Function, dayname: Exported functions
Function, deal-with-am-pm: Internal functions
Function, deal-with-izone: Internal functions
Function, deal-with-noon-midn: Internal functions
Function, decode-universal-time/plist: Exported functions
Function, decoded-time-day: Internal functions
Function, decoded-time-dotw: Internal functions
Function, decoded-time-hour: Internal functions
Function, decoded-time-minute: Internal functions
Function, decoded-time-month: Internal functions
Function, decoded-time-p: Internal functions
Function, decoded-time-second: Internal functions
Function, decoded-time-year: Internal functions
Function, decoded-time-zone: Internal functions
Function, decompose-string: Internal functions
Function, hour: Exported functions
Function, izone: Internal functions
Function, make-decoded-time: Internal functions
Function, make-default-time: Internal functions
Function, match-pattern: Internal functions
Function, match-pattern-element: Internal functions
Function, match-substring: Internal functions
Function, minute: Exported functions
Function, month: Exported functions
Function, monthname: Exported functions
Function, noon-midn: Internal functions
Function, now: Internal functions
Function, parse-time: Exported functions
Function, secondp: Internal functions
Function, set-current-value: Internal functions
Function, set-time-values: Internal functions
Function, special-string-p: Internal functions
Function, time-divider: Internal functions
Function, today: Internal functions
Function, tomorrow: Internal functions
Function, universal-time-to-http-date: Exported functions
Function, universal-time-to-rfc-date: Exported functions
Function, universal-time-to-rfc2822-date: Exported functions
Function, weekday: Internal functions
Function, year: Exported functions
Function, yesterday: Internal functions
Function, zone: Exported functions

H
hashlist: Internal macros
hour: Exported functions

I
izone: Internal functions

M
Macro, hashlist: Internal macros
Macro, with-date: Exported macros
Macro, with-decoding: Exported macros
make-decoded-time: Internal functions
make-default-time: Internal functions
match-pattern: Internal functions
match-pattern-element: Internal functions
match-substring: Internal functions
minute: Exported functions
month: Exported functions
monthname: Exported functions

N
noon-midn: Internal functions
now: Internal functions

P
parse-time: Exported functions

S
secondp: Internal functions
set-current-value: Internal functions
set-time-values: Internal functions
special-string-p: Internal functions

T
time-divider: Internal functions
today: Internal functions
tomorrow: Internal functions

U
universal-time-to-http-date: Exported functions
universal-time-to-rfc-date: Exported functions
universal-time-to-rfc2822-date: Exported functions

W
weekday: Internal functions
with-date: Exported macros
with-decoding: Exported macros

Y
year: Exported functions
yesterday: Internal functions

Z
zone: Exported functions

Jump to:   (  
A   C   D   F   H   I   M   N   P   S   T   U   W   Y   Z  

Next: , Previous: , Up: Indexes   [Contents][Index]

A.3 Variables

Jump to:   *  
D   H   M   S   T   W   Y   Z  
Index Entry  Section

*
*day-names*: Internal special variables
*default-date-time-patterns*: Internal special variables
*error-on-mismatch*: Internal special variables
*http-date-time-patterns*: Internal special variables
*month-names*: Internal special variables
*month-strings*: Internal special variables
*special-strings*: Internal special variables
*weekday-strings*: Internal special variables
*zone-strings*: Internal special variables

D
date-dividers: Internal special variables
day: Internal structures
dotw: Internal structures

H
hour: Internal structures

M
minute: Internal structures
month: Internal structures
month-table-size: Internal special variables

S
second: Internal structures
Slot, day: Internal structures
Slot, dotw: Internal structures
Slot, hour: Internal structures
Slot, minute: Internal structures
Slot, month: Internal structures
Slot, second: Internal structures
Slot, year: Internal structures
Slot, zone: Internal structures
Special Variable, *day-names*: Internal special variables
Special Variable, *default-date-time-patterns*: Internal special variables
Special Variable, *error-on-mismatch*: Internal special variables
Special Variable, *http-date-time-patterns*: Internal special variables
Special Variable, *month-names*: Internal special variables
Special Variable, *month-strings*: Internal special variables
Special Variable, *special-strings*: Internal special variables
Special Variable, *weekday-strings*: Internal special variables
Special Variable, *zone-strings*: Internal special variables
Special Variable, date-dividers: Internal special variables
Special Variable, month-table-size: Internal special variables
Special Variable, special-table-size: Internal special variables
Special Variable, time-dividers: Internal special variables
Special Variable, weekday-table-size: Internal special variables
Special Variable, whitespace-chars: Internal special variables
Special Variable, zone-table-size: Internal special variables
special-table-size: Internal special variables

T
time-dividers: Internal special variables

W
weekday-table-size: Internal special variables
whitespace-chars: Internal special variables

Y
year: Internal structures

Z
zone: Internal structures
zone-table-size: Internal special variables

Jump to:   *  
D   H   M   S   T   W   Y   Z  

Previous: , Up: Indexes   [Contents][Index]

A.4 Data types

Jump to:   D   N   P   S  
Index Entry  Section

D
decoded-time: Internal structures

N
net-telent-date: The net-telent-date system
net-telent-date-system: The net-telent-date-system package
net.telent.date: The net<dot>telent<dot>date package

P
Package, net-telent-date-system: The net-telent-date-system package
Package, net.telent.date: The net<dot>telent<dot>date package

S
Structure, decoded-time: Internal structures
System, net-telent-date: The net-telent-date system

Jump to:   D   N   P   S