The definitions-systems Reference Manual

Table of Contents

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

The definitions-systems Reference Manual

This is the definitions-systems Reference Manual, version 1.0, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Jul 29 15:31:42 2019 GMT+0.


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

1 Introduction

Project's home: https://www.hexstreamsoft.com/libraries/definitions-systems/


definitions-systems provides a simple unified extensible way of processing named definitions.


This library is in the Public Domain.
See the UNLICENSE file for details.


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 definitions-systems

Author

Jean-Philippe Paradis <hexstream@hexstreamsoft.com>

License

Public Domain

Description

Provides a simple unified extensible way of processing named definitions.

Version

1.0

Dependencies
Source

definitions-systems.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 definitions-systems.asd

Location

definitions-systems.asd

Systems

definitions-systems (system)


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

3.1.2 definitions-systems/package.lisp

Parent

definitions-systems (system)

Location

package.lisp

Packages

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

3.1.3 definitions-systems/main.lisp

Dependency

package.lisp (file)

Parent

definitions-systems (system)

Location

main.lisp

Exported Definitions
Internal Definitions

*root-system* (special variable)


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

3.1.4 definitions-systems/ikeywords.lisp

Dependency

main.lisp (file)

Parent

definitions-systems (system)

Location

ikeywords.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 definitions-systems

Source

package.lisp (file)

Nickname

defsys

Use List

common-lisp

Exported Definitions
Internal Definitions

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

4.2 definitions-systems.ikeyword

Source

package.lisp (file)

Nickname

defsys.ikeyword

Use List

ikeyword


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: define (KIND DEFINITION-NAME &body OPTIONS) &body ARGS
Package

definitions-systems

Source

main.lisp (file)


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

5.1.2 Functions

Function: root-system ()
Package

definitions-systems

Source

main.lisp (file)


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

5.1.3 Generic functions

Generic Function: boundp SYSTEM DEFINITION-NAME
Package

definitions-systems

Source

main.lisp (file)

Methods
Method: boundp (SYSTEM ikeywords-mixin) (DEFINITION-NAME symbol) around
Source

ikeywords.lisp (file)

Method: boundp SYSTEM DEFINITION-NAME
Generic Function: expand-definition SYSTEM DEFINITION-NAME ENVIRONMENT ARGS &rest OPTIONS &key &allow-other-keys
Package

definitions-systems

Source

main.lisp (file)

Methods
Method: expand-definition (SYSTEM ikeywords-mixin) (DEFINITION-NAME symbol) ENVIRONMENT ARGS &rest OPTIONS &key &allow-other-keys around
Source

ikeywords.lisp (file)

Method: expand-definition (SYSTEM-NAME symbol) DEFINITION-NAME ENVIRONMENT ARGS &rest OPTIONS
Generic Function: locate SYSTEM DEFINITION-NAME &key ERRORP
Generic Function: (setf locate) NEW-DEFINITION SYSTEM DEFINITION-NAME &key ERRORP
Package

definitions-systems

Source

main.lisp (file)

Methods
Method: locate (SYSTEM ikeywords-mixin) (DEFINITION-NAME symbol) &key ERRORP around
Method: (setf locate) NEW-DEFINITION (SYSTEM ikeywords-mixin) (DEFINITION-NAME symbol) &key ERRORP around
Source

ikeywords.lisp (file)

Method: locate SYSTEM DEFINITION-NAME &key ERRORP around
Method: locate (SYSTEM-NAME symbol) DEFINITION-NAME &key ERRORP
Method: (setf locate) NEW-DEFINITION (SYSTEM-NAME symbol) DEFINITION-NAME &key ERRORP
Method: locate (SYSTEM hash-table-mixin) DEFINITION-NAME &key ERRORP
Method: (setf locate) NEW-DEFINITION (SYSTEM hash-table-mixin) DEFINITION-NAME &key ERRORP
Generic Function: name SYSTEM
Package

definitions-systems

Source

main.lisp (file)

Methods
Method: name (CONDITION not-found)
Method: name (NAME-MIXIN name-mixin)

automatically generated reader method

Generic Function: system CONDITION
Package

definitions-systems

Methods
Method: system (CONDITION not-found)
Source

main.lisp (file)

Generic Function: unbind SYSTEM DEFINITION-NAME
Package

definitions-systems

Source

main.lisp (file)

Methods
Method: unbind (SYSTEM ikeywords-mixin) (DEFINITION-NAME symbol) around
Source

ikeywords.lisp (file)

Method: unbind (SYSTEM-NAME symbol) DEFINITION-NAME
Method: unbind (SYSTEM hash-table-mixin) DEFINITION-NAME

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

5.1.4 Conditions

Condition: not-found ()
Package

definitions-systems

Source

main.lisp (file)

Direct superclasses

error (condition)

Direct methods
Direct slots
Slot: %system
Initargs

:system

Readers

system (generic function)

Slot: %name
Initargs

:name

Readers

name (generic function)


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

5.1.5 Classes

Class: hash-table-mixin ()
Package

definitions-systems

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

standard-system (class)

Direct methods
Direct slots
Slot: %hash
Type

hash-table

Initform

(make-hash-table :test (quote eq))

Class: ikeywords-mixin ()
Package

definitions-systems

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Class: name-mixin ()
Package

definitions-systems

Source

main.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses

standard-system (class)

Direct methods
  • print-object (method)
  • name (method)
Direct slots
Slot: %name
Type

symbol

Initargs

:name

Readers

name (generic function)

Class: standard-system ()
Package

definitions-systems

Source

main.lisp (file)

Direct superclasses
Class: system ()
Package

definitions-systems

Source

main.lisp (file)

Direct superclasses

standard-object (class)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *root-system*
Package

definitions-systems

Source

main.lisp (file)


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

5.2.2 Functions

Function: %forward-ikeyword FORWARD CONTINUE SYSTEM DEFINITION-NAME &rest KEYS
Function: (setf %forward-ikeyword) NEW FORWARD CONTINUE SYSTEM DEFINITION-NAME &rest KEYS
Package

definitions-systems

Source

ikeywords.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   D   F   L  
Index Entry  Section

D
definitions-systems.asd: The definitions-systems<dot>asd file
definitions-systems/ikeywords.lisp: The definitions-systems/ikeywords<dot>lisp file
definitions-systems/main.lisp: The definitions-systems/main<dot>lisp file
definitions-systems/package.lisp: The definitions-systems/package<dot>lisp file

F
File, Lisp, definitions-systems.asd: The definitions-systems<dot>asd file
File, Lisp, definitions-systems/ikeywords.lisp: The definitions-systems/ikeywords<dot>lisp file
File, Lisp, definitions-systems/main.lisp: The definitions-systems/main<dot>lisp file
File, Lisp, definitions-systems/package.lisp: The definitions-systems/package<dot>lisp file

L
Lisp File, definitions-systems.asd: The definitions-systems<dot>asd file
Lisp File, definitions-systems/ikeywords.lisp: The definitions-systems/ikeywords<dot>lisp file
Lisp File, definitions-systems/main.lisp: The definitions-systems/main<dot>lisp file
Lisp File, definitions-systems/package.lisp: The definitions-systems/package<dot>lisp file

Jump to:   D   F   L  

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

A.2 Functions

Jump to:   %   (  
B   D   E   F   G   L   M   N   R   S   U  
Index Entry  Section

%
%forward-ikeyword: Internal functions

(
(setf %forward-ikeyword): Internal functions
(setf locate): Exported generic functions
(setf locate): Exported generic functions
(setf locate): Exported generic functions
(setf locate): Exported generic functions

B
boundp: Exported generic functions
boundp: Exported generic functions
boundp: Exported generic functions

D
define: Exported macros

E
expand-definition: Exported generic functions
expand-definition: Exported generic functions
expand-definition: Exported generic functions

F
Function, %forward-ikeyword: Internal functions
Function, (setf %forward-ikeyword): Internal functions
Function, root-system: Exported functions

G
Generic Function, (setf locate): Exported generic functions
Generic Function, boundp: Exported generic functions
Generic Function, expand-definition: Exported generic functions
Generic Function, locate: Exported generic functions
Generic Function, name: Exported generic functions
Generic Function, system: Exported generic functions
Generic Function, unbind: Exported generic functions

L
locate: Exported generic functions
locate: Exported generic functions
locate: Exported generic functions
locate: Exported generic functions
locate: Exported generic functions

M
Macro, define: Exported macros
Method, (setf locate): Exported generic functions
Method, (setf locate): Exported generic functions
Method, (setf locate): Exported generic functions
Method, boundp: Exported generic functions
Method, boundp: Exported generic functions
Method, expand-definition: Exported generic functions
Method, expand-definition: Exported generic functions
Method, locate: Exported generic functions
Method, locate: Exported generic functions
Method, locate: Exported generic functions
Method, locate: Exported generic functions
Method, name: Exported generic functions
Method, name: Exported generic functions
Method, system: Exported generic functions
Method, unbind: Exported generic functions
Method, unbind: Exported generic functions
Method, unbind: Exported generic functions

N
name: Exported generic functions
name: Exported generic functions
name: Exported generic functions

R
root-system: Exported functions

S
system: Exported generic functions
system: Exported generic functions

U
unbind: Exported generic functions
unbind: Exported generic functions
unbind: Exported generic functions
unbind: Exported generic functions

Jump to:   %   (  
B   D   E   F   G   L   M   N   R   S   U  

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

A.3 Variables

Jump to:   %   *  
S  
Index Entry  Section

%
%hash: Exported classes
%name: Exported conditions
%name: Exported classes
%system: Exported conditions

*
*root-system*: Internal special variables

S
Slot, %hash: Exported classes
Slot, %name: Exported conditions
Slot, %name: Exported classes
Slot, %system: Exported conditions
Special Variable, *root-system*: Internal special variables

Jump to:   %   *  
S  

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

A.4 Data types

Jump to:   C   D   H   I   N   P   S  
Index Entry  Section

C
Class, hash-table-mixin: Exported classes
Class, ikeywords-mixin: Exported classes
Class, name-mixin: Exported classes
Class, standard-system: Exported classes
Class, system: Exported classes
Condition, not-found: Exported conditions

D
definitions-systems: The definitions-systems system
definitions-systems: The definitions-systems package
definitions-systems.ikeyword: The definitions-systems<dot>ikeyword package

H
hash-table-mixin: Exported classes

I
ikeywords-mixin: Exported classes

N
name-mixin: Exported classes
not-found: Exported conditions

P
Package, definitions-systems: The definitions-systems package
Package, definitions-systems.ikeyword: The definitions-systems<dot>ikeyword package

S
standard-system: Exported classes
system: Exported classes
System, definitions-systems: The definitions-systems system

Jump to:   C   D   H   I   N   P   S