The net-telent-date Reference Manual

Table of Contents

The net-telent-date Reference Manual

This is the net-telent-date Reference Manual, version 0.41, generated automatically by Declt version 3.0 "Montgomery Scott" on Tue Dec 22 14:29:41 2020 GMT+0.

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

2 Systems

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

2.1 net-telent-date

Version

0.41

Source

net-telent-date.asd (file)

Components

• defpackage.lisp (file)
• date.lisp (file)
• parse-time.lisp (file)

3 Files

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

3.1 Lisp

3.1.1 net-telent-date.asd

Location

net-telent-date.asd

Systems

net-telent-date (system)

Packages

net-telent-date-system

3.1.2 net-telent-date/defpackage.lisp

Parent

net-telent-date (system)

Location

defpackage.lisp

Packages

net.telent.date

3.1.3 net-telent-date/date.lisp

Dependency

defpackage.lisp (file)

Parent

net-telent-date (system)

Location

date.lisp

Exported Definitions

• dayname (function)
• decode-universal-time/plist (function)
• monthname (function)
• universal-time-to-http-date (function)
• universal-time-to-rfc-date (function)
• universal-time-to-rfc2822-date (function)
• with-date (macro)
• with-decoding (macro)

Internal Definitions

• *day-names* (special variable)
• *month-names* (special variable)

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

Dependency

defpackage.lisp (file)

Parent

net-telent-date (system)

Location

parse-time.lisp

Exported Definitions

• hour (function)
• minute (function)
• month (function)
• parse-time (function)
• year (function)
• zone (function)

Internal Definitions

• *default-date-time-patterns* (special variable)
• *error-on-mismatch* (special variable)
• *http-date-time-patterns* (special variable)
• *month-strings* (special variable)
• *special-strings* (special variable)
• *weekday-strings* (special variable)
• *zone-strings* (special variable)
• am-pm (function)
• convert-to-unitime (function)
• copy-decoded-time (function)
• date-divider (function)
• date-dividers (special variable)
• day (function)
• deal-with-am-pm (function)
• deal-with-izone (function)
• deal-with-noon-midn (function)
• decoded-time (structure)
• decoded-time-day (function)
• (setf decoded-time-day) (function)
• decoded-time-dotw (function)
• (setf decoded-time-dotw) (function)
• decoded-time-hour (function)
• (setf decoded-time-hour) (function)
• decoded-time-minute (function)
• (setf decoded-time-minute) (function)
• decoded-time-month (function)
• (setf decoded-time-month) (function)
• decoded-time-p (function)
• decoded-time-second (function)
• (setf decoded-time-second) (function)
• decoded-time-year (function)
• (setf decoded-time-year) (function)
• decoded-time-zone (function)
• (setf decoded-time-zone) (function)
• decompose-string (function)
• hashlist (macro)
• izone (function)
• make-decoded-time (function)
• make-default-time (function)
• match-pattern (function)
• match-pattern-element (function)
• match-substring (function)
• month-table-size (special variable)
• noon-midn (function)
• now (function)
• secondp (function)
• set-current-value (function)
• set-time-values (function)
• special-string-p (function)
• special-table-size (special variable)
• time-divider (function)
• time-dividers (special variable)
• today (function)
• tomorrow (function)
• weekday (function)
• weekday-table-size (special variable)
• whitespace-chars (special variable)
• yesterday (function)
• zone-table-size (special variable)

4 Packages

Packages are listed by definition order.

4.1 net-telent-date-system

Source

net-telent-date.asd

Use List

• asdf/interface
• common-lisp

4.2 net.telent.date

Source

defpackage.lisp (file)

Nickname

date

Use List

common-lisp

Exported Definitions

• dayname (function)
• decode-universal-time/plist (function)
• hour (function)
• minute (function)
• month (function)
• monthname (function)
• parse-time (function)
• universal-time-to-http-date (function)
• universal-time-to-rfc-date (function)
• universal-time-to-rfc2822-date (function)
• with-date (macro)
• with-decoding (macro)
• year (function)
• zone (function)

Internal Definitions

• *day-names* (special variable)
• *default-date-time-patterns* (special variable)
• *error-on-mismatch* (special variable)
• *http-date-time-patterns* (special variable)
• *month-names* (special variable)
• *month-strings* (special variable)
• *special-strings* (special variable)
• *weekday-strings* (special variable)
• *zone-strings* (special variable)
• am-pm (function)
• convert-to-unitime (function)
• copy-decoded-time (function)
• date-divider (function)
• date-dividers (special variable)
• day (function)
• deal-with-am-pm (function)
• deal-with-izone (function)
• deal-with-noon-midn (function)
• decoded-time (structure)
• decoded-time-day (function)
• (setf decoded-time-day) (function)
• decoded-time-dotw (function)
• (setf decoded-time-dotw) (function)
• decoded-time-hour (function)
• (setf decoded-time-hour) (function)
• decoded-time-minute (function)
• (setf decoded-time-minute) (function)
• decoded-time-month (function)
• (setf decoded-time-month) (function)
• decoded-time-p (function)
• decoded-time-second (function)
• (setf decoded-time-second) (function)
• decoded-time-year (function)
• (setf decoded-time-year) (function)
• decoded-time-zone (function)
• (setf decoded-time-zone) (function)
• decompose-string (function)
• hashlist (macro)
• izone (function)
• make-decoded-time (function)
• make-default-time (function)
• match-pattern (function)
• match-pattern-element (function)
• match-substring (function)
• month-table-size (special variable)
• noon-midn (function)
• now (function)
• secondp (function)
• set-current-value (function)
• set-time-values (function)
• special-string-p (function)
• special-table-size (special variable)
• time-divider (function)
• time-dividers (special variable)
• today (function)
• tomorrow (function)
• weekday (function)
• weekday-table-size (special variable)
• whitespace-chars (special variable)
• yesterday (function)
• zone-table-size (special variable)

5 Definitions

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

5.1 Exported definitions

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)

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)

5.2 Internal definitions

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)

5.2.2 Macros

Macro: hashlist LIST TABLE

Package

net.telent.date

Source

parse-time.lisp (file)

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)

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)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types