The net-telent-date Reference Manual

This is the net-telent-date Reference Manual, version 0.41, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:24:49 2024 GMT+0.

Table of Contents


1 Introduction


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.

Child Components

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/net-telent-date.asd

Source

net-telent-date.asd.

Parent Component

net-telent-date (system).

ASDF Systems

net-telent-date.

Packages

net-telent-date-system.


3.1.2 net-telent-date/defpackage.lisp

Source

net-telent-date.asd.

Parent Component

net-telent-date (system).

Packages

net.telent.date.


3.1.3 net-telent-date/date.lisp

Dependency

defpackage.lisp (file).

Source

net-telent-date.asd.

Parent Component

net-telent-date (system).

Public Interface
Internals

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

Dependency

defpackage.lisp (file).

Source

net-telent-date.asd.

Parent Component

net-telent-date (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 net.telent.date

Source

defpackage.lisp.

Nickname

date

Use List

common-lisp.

Public Interface
Internals

4.2 net-telent-date-system

Source

net-telent-date.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


5.1 Public Interface


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.

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.


5.1.2 Ordinary 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.

Function: decode-universal-time/plist (utime &optional zone)
Package

net.telent.date.

Source

date.lisp.

Function: hour (number)
Package

net.telent.date.

Source

parse-time.lisp.

Function: minute (number)
Package

net.telent.date.

Source

parse-time.lisp.

Function: month (thing)
Package

net.telent.date.

Source

parse-time.lisp.

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.

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.

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.

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.

Alias for

universal-time-to-http-date.

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.

Function: year (number)
Package

net.telent.date.

Source

parse-time.lisp.

Function: zone (thing)
Package

net.telent.date.

Source

parse-time.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *day-names*
Package

net.telent.date.

Source

date.lisp.

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

net.telent.date.

Source

parse-time.lisp.

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.

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

net.telent.date.

Source

parse-time.lisp.

Special Variable: *month-names*
Package

net.telent.date.

Source

date.lisp.

Special Variable: *month-strings*
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: *special-strings*
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: *weekday-strings*
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: *zone-strings*
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: date-dividers
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: month-table-size
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: special-table-size
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: time-dividers
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: weekday-table-size
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: whitespace-chars
Package

net.telent.date.

Source

parse-time.lisp.

Special Variable: zone-table-size
Package

net.telent.date.

Source

parse-time.lisp.


5.2.2 Macros

Macro: hashlist (list table)
Package

net.telent.date.

Source

parse-time.lisp.


5.2.3 Ordinary functions

Function: am-pm (string)
Package

net.telent.date.

Source

parse-time.lisp.

Function: convert-to-unitime (parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.

Function: copy-decoded-time (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Function: date-divider (character)
Package

net.telent.date.

Source

parse-time.lisp.

Function: day (number)
Package

net.telent.date.

Source

parse-time.lisp.

Function: deal-with-am-pm (form-value parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.

Function: deal-with-izone (form-value parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.

Function: deal-with-noon-midn (form-value parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.

Reader: decoded-time-day (instance)
Writer: (setf decoded-time-day) (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Target Slot

day.

Reader: decoded-time-dotw (instance)
Writer: (setf decoded-time-dotw) (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Target Slot

dotw.

Reader: decoded-time-hour (instance)
Writer: (setf decoded-time-hour) (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Target Slot

hour.

Reader: decoded-time-minute (instance)
Writer: (setf decoded-time-minute) (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Target Slot

minute.

Reader: decoded-time-month (instance)
Writer: (setf decoded-time-month) (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Target Slot

month.

Function: decoded-time-p (object)
Package

net.telent.date.

Source

parse-time.lisp.

Reader: decoded-time-second (instance)
Writer: (setf decoded-time-second) (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Target Slot

second.

Reader: decoded-time-year (instance)
Writer: (setf decoded-time-year) (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Target Slot

year.

Reader: decoded-time-zone (instance)
Writer: (setf decoded-time-zone) (instance)
Package

net.telent.date.

Source

parse-time.lisp.

Target Slot

zone.

Function: decompose-string (string &key start end radix)
Package

net.telent.date.

Source

parse-time.lisp.

Function: izone (thing)
Package

net.telent.date.

Source

parse-time.lisp.

Function: make-decoded-time (&key second minute hour day month year zone dotw)
Package

net.telent.date.

Source

parse-time.lisp.

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.

Function: match-pattern (pattern datum datum-length)
Package

net.telent.date.

Source

parse-time.lisp.

Function: match-pattern-element (pattern-element datum-element)
Package

net.telent.date.

Source

parse-time.lisp.

Function: match-substring (substring)
Package

net.telent.date.

Source

parse-time.lisp.

Function: noon-midn (string)
Package

net.telent.date.

Source

parse-time.lisp.

Function: now (parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.

Function: secondp (number)
Package

net.telent.date.

Source

parse-time.lisp.

Function: set-current-value (values-structure &key time date zone)
Package

net.telent.date.

Source

parse-time.lisp.

Function: set-time-values (string-form parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.

Function: special-string-p (string)
Package

net.telent.date.

Source

parse-time.lisp.

Function: time-divider (character)
Package

net.telent.date.

Source

parse-time.lisp.

Function: today (parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.

Function: tomorrow (parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.

Function: weekday (string)
Package

net.telent.date.

Source

parse-time.lisp.

Function: yesterday (parsed-values)
Package

net.telent.date.

Source

parse-time.lisp.


5.2.4 Structures

Structure: decoded-time
Package

net.telent.date.

Source

parse-time.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: second
Package

common-lisp.

Type

integer

Initform

0

Readers

decoded-time-second.

Writers

(setf decoded-time-second).

Slot: minute
Type

integer

Initform

0

Readers

decoded-time-minute.

Writers

(setf decoded-time-minute).

Slot: hour
Type

integer

Initform

0

Readers

decoded-time-hour.

Writers

(setf decoded-time-hour).

Slot: day
Type

integer

Initform

1

Readers

decoded-time-day.

Writers

(setf decoded-time-day).

Slot: month
Type

integer

Initform

1

Readers

decoded-time-month.

Writers

(setf decoded-time-month).

Slot: year
Type

integer

Initform

1900

Readers

decoded-time-year.

Writers

(setf decoded-time-year).

Slot: zone
Type

rational

Initform

0

Readers

decoded-time-zone.

Writers

(setf decoded-time-zone).

Slot: dotw
Type

integer

Initform

0

Readers

decoded-time-dotw.

Writers

(setf decoded-time-dotw).


Appendix A Indexes


A.1 Concepts


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): Private ordinary functions
(setf decoded-time-dotw): Private ordinary functions
(setf decoded-time-hour): Private ordinary functions
(setf decoded-time-minute): Private ordinary functions
(setf decoded-time-month): Private ordinary functions
(setf decoded-time-second): Private ordinary functions
(setf decoded-time-year): Private ordinary functions
(setf decoded-time-zone): Private ordinary functions

A
am-pm: Private ordinary functions

C
convert-to-unitime: Private ordinary functions
copy-decoded-time: Private ordinary functions

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

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

H
hashlist: Private macros
hour: Public ordinary functions

I
izone: Private ordinary functions

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

N
noon-midn: Private ordinary functions
now: Private ordinary functions

P
parse-time: Public ordinary functions

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

T
time-divider: Private ordinary functions
today: Private ordinary functions
tomorrow: Private ordinary functions

U
universal-time-to-http-date: Public ordinary functions
universal-time-to-rfc-date: Public ordinary functions
universal-time-to-rfc2822-date: Public ordinary functions

W
weekday: Private ordinary functions
with-date: Public macros
with-decoding: Public macros

Y
year: Public ordinary functions
yesterday: Private ordinary functions

Z
zone: Public ordinary functions


A.3 Variables

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

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

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

H
hour: Private structures

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

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

T
time-dividers: Private special variables

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

Y
year: Private structures

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