The temporal-functions Reference Manual

This is the temporal-functions Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 07:06:15 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 temporal-functions

A means of creating functions that have an internal concept of time

Author

Chris Bagley <>

License

2 Clause BSD

Dependency

fn (system).

Source

temporal-functions.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 temporal-functions/temporal-functions.asd

Source

temporal-functions.asd.

Parent Component

temporal-functions (system).

ASDF Systems

temporal-functions.


3.1.2 temporal-functions/package.lisp

Source

temporal-functions.asd.

Parent Component

temporal-functions (system).

Packages

3.1.3 temporal-functions/helpers.lisp

Dependency

package.lisp (file).

Source

temporal-functions.asd.

Parent Component

temporal-functions (system).

Internals

case= (macro).


3.1.4 temporal-functions/units.lisp

Dependency

helpers.lisp (file).

Source

temporal-functions.asd.

Parent Component

temporal-functions (system).

Public Interface
Internals

ms (function).


3.1.5 temporal-functions/temporal-functions.lisp

Dependency

units.lisp (file).

Source

temporal-functions.asd.

Parent Component

temporal-functions (system).

Public Interface
Internals

3.1.6 temporal-functions/tiny-time-manager.lisp

Dependency

temporal-functions.lisp (file).

Source

temporal-functions.asd.

Parent Component

temporal-functions (system).

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 tiny-time-manager

Source

package.lisp.

Nickname

ttm

Use List
Public Interface
Internals

4.2 temporal-functions

Source

package.lisp.

Use List

common-lisp.

Used By List

tiny-time-manager.

Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: after (delay &body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: before (deadline &body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: def-time-units (&body forms)
Package

temporal-functions.

Source

units.lisp.

Macro: defun-t (name args &body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: each (delay &body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: expiredp (&body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: expiredp+ (&body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: repeat (&body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: then (&body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: tlambda (args &body body)
Package

temporal-functions.

Source

temporal-functions.lisp.


5.1.2 Ordinary functions

Function: add (item &optional pool)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Function: clean (&optional pool)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Function: hours (quantity)
Package

temporal-functions.

Source

units.lisp.

Function: make-stepper (step-size &optional max-cache-size default-source allow-replace-source)

this takes absolute sources

Package

temporal-functions.

Source

temporal-functions.lisp.

Function: make-tfunc-pool ()
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Function: milliseconds (quantity)
Package

temporal-functions.

Source

units.lisp.

Function: minutes (quantity)
Package

temporal-functions.

Source

units.lisp.

Function: release (item &optional pool)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Function: seconds (quantity)
Package

temporal-functions.

Source

units.lisp.

Function: signal-expired ()
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: update (&optional pool)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *default-time-source*
Package

temporal-functions.

Source

temporal-functions.lisp.

Special Variable: *default-time-source-name*
Package

temporal-functions.

Source

temporal-functions.lisp.

Special Variable: *init-arg*
Package

temporal-functions.

Source

temporal-functions.lisp.

Special Variable: *progress-var*
Package

temporal-functions.

Source

temporal-functions.lisp.

Special Variable: *temporal-clause-expanders*
Package

temporal-functions.

Source

temporal-functions.lisp.

Special Variable: *time-var*
Package

temporal-functions.

Source

temporal-functions.lisp.


5.2.2 Macros

Macro: case= (form &body cases)
Package

temporal-functions.

Source

helpers.lisp.

Macro: def-t-expander (name args &body body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Macro: with-compile-result (form &body wcr-body)
Package

temporal-functions.

Source

temporal-functions.lisp.


5.2.3 Ordinary functions

Function: %make-tfp (&key funcs)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Function: after-expander (delay &rest body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: before-expander (deadline &rest body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: clean-result (result)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: copy-temporal-func-pool (instance)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Function: each-expander (delay &rest body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: empty-result ()
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: expose (&optional pool)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Function: gen-t-r-step (compile-result step-num start-var top step-var)

each then/repeat step has two steps. One that sets up and another than runs

Package

temporal-functions.

Source

temporal-functions.lisp.

Function: improve-readability (form)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: mapcat (function &rest lists)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: merge-results (results &optional first-overrides-body-form)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: ms (quantity)
Package

temporal-functions.

Source

units.lisp.

Function: new-result (&key closed-vars start-test expire-test funcs init body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: once-expander (&rest body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: process-t-body (form)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: repeat-expander (&rest forms)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: t-init-base (compiled)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: tbody (compiled)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: tcompile (body)
Package

temporal-functions.

Source

temporal-functions.lisp.

Reader: temporal-func-pool-funcs (instance)
Writer: (setf temporal-func-pool-funcs) (instance)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Target Slot

funcs.

Function: temporal-func-pool-p (object)
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Function: then-expander (&rest forms)
Package

temporal-functions.

Source

temporal-functions.lisp.

Function: until-expander (test &rest body)
Package

temporal-functions.

Source

temporal-functions.lisp.


5.2.4 Generic functions

Generic Reader: body (object)
Package

temporal-functions.

Methods
Reader Method: body ((result result))

automatically generated reader method

Source

temporal-functions.lisp.

Target Slot

body.

Generic Writer: (setf body) (object)
Package

temporal-functions.

Methods
Writer Method: (setf body) ((result result))

automatically generated writer method

Source

temporal-functions.lisp.

Target Slot

body.

Generic Reader: closed-vars (object)
Package

temporal-functions.

Methods
Reader Method: closed-vars ((result result))

automatically generated reader method

Source

temporal-functions.lisp.

Target Slot

closed-vars.

Generic Writer: (setf closed-vars) (object)
Package

temporal-functions.

Methods
Writer Method: (setf closed-vars) ((result result))

automatically generated writer method

Source

temporal-functions.lisp.

Target Slot

closed-vars.

Generic Reader: expire-test (object)
Package

temporal-functions.

Methods
Reader Method: expire-test ((result result))

automatically generated reader method

Source

temporal-functions.lisp.

Target Slot

expire-test.

Generic Writer: (setf expire-test) (object)
Package

temporal-functions.

Methods
Writer Method: (setf expire-test) ((result result))

automatically generated writer method

Source

temporal-functions.lisp.

Target Slot

expire-test.

Generic Reader: funcs (object)
Package

temporal-functions.

Methods
Reader Method: funcs ((result result))

automatically generated reader method

Source

temporal-functions.lisp.

Target Slot

funcs.

Generic Writer: (setf funcs) (object)
Package

temporal-functions.

Methods
Writer Method: (setf funcs) ((result result))

automatically generated writer method

Source

temporal-functions.lisp.

Target Slot

funcs.

Generic Reader: init (object)
Package

temporal-functions.

Methods
Reader Method: init ((result result))

automatically generated reader method

Source

temporal-functions.lisp.

Target Slot

init.

Generic Writer: (setf init) (object)
Package

temporal-functions.

Methods
Writer Method: (setf init) ((result result))

automatically generated writer method

Source

temporal-functions.lisp.

Target Slot

init.

Generic Reader: start-test (object)
Package

temporal-functions.

Methods
Reader Method: start-test ((result result))

automatically generated reader method

Source

temporal-functions.lisp.

Target Slot

start-test.

Generic Writer: (setf start-test) (object)
Package

temporal-functions.

Methods
Writer Method: (setf start-test) ((result result))

automatically generated writer method

Source

temporal-functions.lisp.

Target Slot

start-test.


5.2.5 Conditions

Condition: c-expired
Package

temporal-functions.

Source

temporal-functions.lisp.

Direct superclasses

condition.


5.2.6 Structures

Structure: temporal-func-pool
Package

tiny-time-manager.

Source

tiny-time-manager.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: funcs
Type

list

Initform

(list t)

Readers

temporal-func-pool-funcs.

Writers

(setf temporal-func-pool-funcs).


5.2.7 Classes

Class: result
Package

temporal-functions.

Source

temporal-functions.lisp.

Direct methods
Direct slots
Slot: closed-vars
Initargs

:closed-vars

Readers

closed-vars.

Writers

(setf closed-vars).

Slot: start-test
Initargs

:start-test

Readers

start-test.

Writers

(setf start-test).

Slot: expire-test
Initargs

:expire-test

Readers

expire-test.

Writers

(setf expire-test).

Slot: funcs
Initargs

:funcs

Readers

funcs.

Writers

(setf funcs).

Slot: init
Initargs

:init

Readers

init.

Writers

(setf init).

Slot: body
Initargs

:body

Readers

body.

Writers

(setf body).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   %   (  
A   B   C   D   E   F   G   H   I   M   N   O   P   R   S   T   U   W  
Index Entry  Section

%
%make-tfp: Private ordinary functions

(
(setf body): Private generic functions
(setf body): Private generic functions
(setf closed-vars): Private generic functions
(setf closed-vars): Private generic functions
(setf expire-test): Private generic functions
(setf expire-test): Private generic functions
(setf funcs): Private generic functions
(setf funcs): Private generic functions
(setf init): Private generic functions
(setf init): Private generic functions
(setf start-test): Private generic functions
(setf start-test): Private generic functions
(setf temporal-func-pool-funcs): Private ordinary functions

A
add: Public ordinary functions
after: Public macros
after-expander: Private ordinary functions

B
before: Public macros
before-expander: Private ordinary functions
body: Private generic functions
body: Private generic functions

C
case=: Private macros
clean: Public ordinary functions
clean-result: Private ordinary functions
closed-vars: Private generic functions
closed-vars: Private generic functions
copy-temporal-func-pool: Private ordinary functions

D
def-t-expander: Private macros
def-time-units: Public macros
defun-t: Public macros

E
each: Public macros
each-expander: Private ordinary functions
empty-result: Private ordinary functions
expire-test: Private generic functions
expire-test: Private generic functions
expiredp: Public macros
expiredp+: Public macros
expose: Private ordinary functions

F
funcs: Private generic functions
funcs: Private generic functions
Function, %make-tfp: Private ordinary functions
Function, (setf temporal-func-pool-funcs): Private ordinary functions
Function, add: Public ordinary functions
Function, after-expander: Private ordinary functions
Function, before-expander: Private ordinary functions
Function, clean: Public ordinary functions
Function, clean-result: Private ordinary functions
Function, copy-temporal-func-pool: Private ordinary functions
Function, each-expander: Private ordinary functions
Function, empty-result: Private ordinary functions
Function, expose: Private ordinary functions
Function, gen-t-r-step: Private ordinary functions
Function, hours: Public ordinary functions
Function, improve-readability: Private ordinary functions
Function, make-stepper: Public ordinary functions
Function, make-tfunc-pool: Public ordinary functions
Function, mapcat: Private ordinary functions
Function, merge-results: Private ordinary functions
Function, milliseconds: Public ordinary functions
Function, minutes: Public ordinary functions
Function, ms: Private ordinary functions
Function, new-result: Private ordinary functions
Function, once-expander: Private ordinary functions
Function, process-t-body: Private ordinary functions
Function, release: Public ordinary functions
Function, repeat-expander: Private ordinary functions
Function, seconds: Public ordinary functions
Function, signal-expired: Public ordinary functions
Function, t-init-base: Private ordinary functions
Function, tbody: Private ordinary functions
Function, tcompile: Private ordinary functions
Function, temporal-func-pool-funcs: Private ordinary functions
Function, temporal-func-pool-p: Private ordinary functions
Function, then-expander: Private ordinary functions
Function, until-expander: Private ordinary functions
Function, update: Public ordinary functions

G
gen-t-r-step: Private ordinary functions
Generic Function, (setf body): Private generic functions
Generic Function, (setf closed-vars): Private generic functions
Generic Function, (setf expire-test): Private generic functions
Generic Function, (setf funcs): Private generic functions
Generic Function, (setf init): Private generic functions
Generic Function, (setf start-test): Private generic functions
Generic Function, body: Private generic functions
Generic Function, closed-vars: Private generic functions
Generic Function, expire-test: Private generic functions
Generic Function, funcs: Private generic functions
Generic Function, init: Private generic functions
Generic Function, start-test: Private generic functions

H
hours: Public ordinary functions

I
improve-readability: Private ordinary functions
init: Private generic functions
init: Private generic functions

M
Macro, after: Public macros
Macro, before: Public macros
Macro, case=: Private macros
Macro, def-t-expander: Private macros
Macro, def-time-units: Public macros
Macro, defun-t: Public macros
Macro, each: Public macros
Macro, expiredp: Public macros
Macro, expiredp+: Public macros
Macro, repeat: Public macros
Macro, then: Public macros
Macro, tlambda: Public macros
Macro, with-compile-result: Private macros
make-stepper: Public ordinary functions
make-tfunc-pool: Public ordinary functions
mapcat: Private ordinary functions
merge-results: Private ordinary functions
Method, (setf body): Private generic functions
Method, (setf closed-vars): Private generic functions
Method, (setf expire-test): Private generic functions
Method, (setf funcs): Private generic functions
Method, (setf init): Private generic functions
Method, (setf start-test): Private generic functions
Method, body: Private generic functions
Method, closed-vars: Private generic functions
Method, expire-test: Private generic functions
Method, funcs: Private generic functions
Method, init: Private generic functions
Method, start-test: Private generic functions
milliseconds: Public ordinary functions
minutes: Public ordinary functions
ms: Private ordinary functions

N
new-result: Private ordinary functions

O
once-expander: Private ordinary functions

P
process-t-body: Private ordinary functions

R
release: Public ordinary functions
repeat: Public macros
repeat-expander: Private ordinary functions

S
seconds: Public ordinary functions
signal-expired: Public ordinary functions
start-test: Private generic functions
start-test: Private generic functions

T
t-init-base: Private ordinary functions
tbody: Private ordinary functions
tcompile: Private ordinary functions
temporal-func-pool-funcs: Private ordinary functions
temporal-func-pool-p: Private ordinary functions
then: Public macros
then-expander: Private ordinary functions
tlambda: Public macros

U
until-expander: Private ordinary functions
update: Public ordinary functions

W
with-compile-result: Private macros


A.4 Data types

Jump to:   C   F   H   P   R   S   T   U  
Index Entry  Section

C
c-expired: Private conditions
Class, result: Private classes
Condition, c-expired: Private conditions

F
File, helpers.lisp: The temporal-functions/helpers․lisp file
File, package.lisp: The temporal-functions/package․lisp file
File, temporal-functions.asd: The temporal-functions/temporal-functions․asd file
File, temporal-functions.lisp: The temporal-functions/temporal-functions․lisp file
File, tiny-time-manager.lisp: The temporal-functions/tiny-time-manager․lisp file
File, units.lisp: The temporal-functions/units․lisp file

H
helpers.lisp: The temporal-functions/helpers․lisp file

P
Package, temporal-functions: The temporal-functions package
Package, tiny-time-manager: The tiny-time-manager package
package.lisp: The temporal-functions/package․lisp file

R
result: Private classes

S
Structure, temporal-func-pool: Private structures
System, temporal-functions: The temporal-functions system

T
temporal-func-pool: Private structures
temporal-functions: The temporal-functions system
temporal-functions: The temporal-functions package
temporal-functions.asd: The temporal-functions/temporal-functions․asd file
temporal-functions.lisp: The temporal-functions/temporal-functions․lisp file
tiny-time-manager: The tiny-time-manager package
tiny-time-manager.lisp: The temporal-functions/tiny-time-manager․lisp file

U
units.lisp: The temporal-functions/units․lisp file