The solid-engine Reference Manual

This is the solid-engine Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Thu Feb 15 07:31:21 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 solid-engine

The Common Lisp stack-based application controller

Author

Makarov Alexey <>

License

MIT

Dependency

alexandria (system).

Source

solid-engine.asd.

Child Components

3 Modules

Modules are listed depth-first from the system components tree.


3.1 solid-engine/src

Dependency

package.lisp (file).

Source

solid-engine.asd.

Parent Component

solid-engine (system).

Child Components

4 Files

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


4.1 Lisp


4.1.1 solid-engine/solid-engine.asd

Source

solid-engine.asd.

Parent Component

solid-engine (system).

ASDF Systems

solid-engine.


4.1.2 solid-engine/package.lisp

Source

solid-engine.asd.

Parent Component

solid-engine (system).

Packages

solid-engine.


4.1.3 solid-engine/src/context.lisp

Source

solid-engine.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.4 solid-engine/src/commands.lisp

Dependency

context.lisp (file).

Source

solid-engine.asd.

Parent Component

src (module).

Public Interface
Internals

4.1.5 solid-engine/src/views.lisp

Dependency

commands.lisp (file).

Source

solid-engine.asd.

Parent Component

src (module).

Public Interface

with-view (macro).

Internals

4.1.6 solid-engine/src/variables.lisp

Dependency

views.lisp (file).

Source

solid-engine.asd.

Parent Component

src (module).

Public Interface
Internals

5 Packages

Packages are listed by definition order.


5.1 solid-engine

Source

package.lisp.

Use List
  • alexandria.
  • common-lisp.
Public Interface
Internals

6 Definitions

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


6.1 Public Interface


6.1.1 Macros

Macro: define-variable ((view variable) &body body)
Package

solid-engine.

Source

variables.lisp.

Macro: dispatch-command (&body commands)
Package

solid-engine.

Source

commands.lisp.

Macro: with-command ((binding) &body body)
Package

solid-engine.

Source

commands.lisp.

Macro: with-solid-engine ((commands parameters) (&rest clauses) &body body)
Package

solid-engine.

Source

context.lisp.

Macro: with-variables ((&rest bindings) &body body)
Package

solid-engine.

Source

variables.lisp.

Macro: with-view ((name &rest args &key &allow-other-keys) &body body)
Package

solid-engine.

Source

views.lisp.


6.1.2 Ordinary functions

Function: bind-variable (name &optional variants)
Package

solid-engine.

Source

variables.lisp.

Function: parameter-value (name &optional function)
Package

solid-engine.

Source

commands.lisp.

Function: reply (name &rest args &key &allow-other-keys)
Package

solid-engine.

Source

context.lisp.

Function: variants (&optional variants)
Package

solid-engine.

Source

variables.lisp.


6.1.3 Standalone methods

Method: initialize-instance :after ((instance context) &key parameters &allow-other-keys)
Source

context.lisp.


6.1.4 Conditions

Condition: reply
Package

solid-engine.

Source

context.lisp.

Direct superclasses

condition.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name-of.

Writers

This slot is read-only.

Slot: commands
Initargs

:commands

Readers

commands-of.

Writers

This slot is read-only.

Slot: parameters
Initargs

:parameters

Readers

parameters-of.

Writers

This slot is read-only.

Slot: view
Initargs

:view

Readers

view-of.

Writers

This slot is read-only.

Slot: args
Initargs

:args

Readers

args-of.

Writers

This slot is read-only.


6.2 Internals


6.2.1 Special variables

Special Variable: *command*
Package

solid-engine.

Source

commands.lisp.

Special Variable: *command-stack*
Package

solid-engine.

Source

commands.lisp.

Special Variable: *context*
Package

solid-engine.

Source

context.lisp.

Special Variable: *variants*
Package

solid-engine.

Source

variables.lisp.

Special Variable: *view*
Package

solid-engine.

Source

views.lisp.


6.2.2 Ordinary functions

Function: call-define-variable (function view variable)
Package

solid-engine.

Source

variables.lisp.

Function: call-with-command (function)
Package

solid-engine.

Source

commands.lisp.

Function: call-with-solid-engine (function path parameters &rest clauses &key &allow-other-keys)
Package

solid-engine.

Source

context.lisp.

Function: call-with-view (function name arguments)
Package

solid-engine.

Source

views.lisp.

Function: command (&optional command)
Package

solid-engine.

Source

commands.lisp.

Function: commands (&optional commands)
Package

solid-engine.

Source

commands.lisp.

Function: context* ()
Package

solid-engine.

Source

context.lisp.

Function: get-variable-value (variable-name &optional view)
Package

solid-engine.

Source

variables.lisp.

Function: list-parameters (command)
Package

solid-engine.

Source

context.lisp.

Function: parameters (&optional stack)
Package

solid-engine.

Source

commands.lisp.

Function: pop-parameter-value (name &optional context)
Package

solid-engine.

Source

context.lisp.

Function: pop-path-segment (&optional context)
Package

solid-engine.

Source

context.lisp.

Function: stack-values (parameters)
Package

solid-engine.

Source

context.lisp.

Function: view (&optional view)
Package

solid-engine.

Source

views.lisp.


6.2.3 Generic functions

Generic Reader: args-of (condition)
Package

solid-engine.

Methods
Reader Method: args-of ((condition reply))
Source

context.lisp.

Target Slot

args.

Generic Reader: arguments-of (object)
Package

solid-engine.

Methods
Reader Method: arguments-of ((view view))

automatically generated reader method

Source

views.lisp.

Target Slot

arguments.

Generic Reader: commands-of (condition)
Package

solid-engine.

Methods
Reader Method: commands-of ((condition reply))
Source

context.lisp.

Target Slot

commands.

Generic Reader: name-of (condition)
Package

solid-engine.

Methods
Reader Method: name-of ((view view))

automatically generated reader method

Source

views.lisp.

Target Slot

name.

Reader Method: name-of ((command command))

automatically generated reader method

Source

commands.lisp.

Target Slot

name.

Reader Method: name-of ((condition reply))
Source

context.lisp.

Target Slot

name.

Generic Reader: parameters-of (object)
Package

solid-engine.

Methods
Reader Method: parameters-of ((command command))

automatically generated reader method

Source

commands.lisp.

Target Slot

parameters.

Reader Method: parameters-of ((condition reply))
Source

context.lisp.

Target Slot

parameters.

Reader Method: parameters-of ((context context))

automatically generated reader method

Source

context.lisp.

Target Slot

parameters.

Generic Reader: path-of (object)
Package

solid-engine.

Methods
Reader Method: path-of ((context context))

automatically generated reader method

Source

context.lisp.

Target Slot

path.

Generic Reader: view-of (condition)
Package

solid-engine.

Methods
Reader Method: view-of ((condition reply))
Source

context.lisp.

Target Slot

view.


6.2.4 Classes

Class: command
Package

solid-engine.

Source

commands.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name-of.

Writers

This slot is read-only.

Slot: parameters
Initform

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

Readers

parameters-of.

Writers

This slot is read-only.

Class: context
Package

solid-engine.

Source

context.lisp.

Direct methods
Direct slots
Slot: parameters
Readers

parameters-of.

Writers

This slot is read-only.

Slot: path
Initargs

:path

Readers

path-of.

Writers

This slot is read-only.

Class: view
Package

solid-engine.

Source

views.lisp.

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

name-of.

Writers

This slot is read-only.

Slot: arguments
Initargs

:arguments

Readers

arguments-of.

Writers

This slot is read-only.


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   A   B   C   D   F   G   I   L   M   N   P   R   S   V   W  
Index Entry  Section

A
args-of: Private generic functions
args-of: Private generic functions
arguments-of: Private generic functions
arguments-of: Private generic functions

B
bind-variable: Public ordinary functions

C
call-define-variable: Private ordinary functions
call-with-command: Private ordinary functions
call-with-solid-engine: Private ordinary functions
call-with-view: Private ordinary functions
command: Private ordinary functions
commands: Private ordinary functions
commands-of: Private generic functions
commands-of: Private generic functions
context*: Private ordinary functions

D
define-variable: Public macros
dispatch-command: Public macros

F
Function, bind-variable: Public ordinary functions
Function, call-define-variable: Private ordinary functions
Function, call-with-command: Private ordinary functions
Function, call-with-solid-engine: Private ordinary functions
Function, call-with-view: Private ordinary functions
Function, command: Private ordinary functions
Function, commands: Private ordinary functions
Function, context*: Private ordinary functions
Function, get-variable-value: Private ordinary functions
Function, list-parameters: Private ordinary functions
Function, parameter-value: Public ordinary functions
Function, parameters: Private ordinary functions
Function, pop-parameter-value: Private ordinary functions
Function, pop-path-segment: Private ordinary functions
Function, reply: Public ordinary functions
Function, stack-values: Private ordinary functions
Function, variants: Public ordinary functions
Function, view: Private ordinary functions

G
Generic Function, args-of: Private generic functions
Generic Function, arguments-of: Private generic functions
Generic Function, commands-of: Private generic functions
Generic Function, name-of: Private generic functions
Generic Function, parameters-of: Private generic functions
Generic Function, path-of: Private generic functions
Generic Function, view-of: Private generic functions
get-variable-value: Private ordinary functions

I
initialize-instance: Public standalone methods

L
list-parameters: Private ordinary functions

M
Macro, define-variable: Public macros
Macro, dispatch-command: Public macros
Macro, with-command: Public macros
Macro, with-solid-engine: Public macros
Macro, with-variables: Public macros
Macro, with-view: Public macros
Method, args-of: Private generic functions
Method, arguments-of: Private generic functions
Method, commands-of: Private generic functions
Method, initialize-instance: Public standalone methods
Method, name-of: Private generic functions
Method, name-of: Private generic functions
Method, name-of: Private generic functions
Method, parameters-of: Private generic functions
Method, parameters-of: Private generic functions
Method, parameters-of: Private generic functions
Method, path-of: Private generic functions
Method, view-of: Private generic functions

N
name-of: Private generic functions
name-of: Private generic functions
name-of: Private generic functions
name-of: Private generic functions

P
parameter-value: Public ordinary functions
parameters: Private ordinary functions
parameters-of: Private generic functions
parameters-of: Private generic functions
parameters-of: Private generic functions
parameters-of: Private generic functions
path-of: Private generic functions
path-of: Private generic functions
pop-parameter-value: Private ordinary functions
pop-path-segment: Private ordinary functions

R
reply: Public ordinary functions

S
stack-values: Private ordinary functions

V
variants: Public ordinary functions
view: Private ordinary functions
view-of: Private generic functions
view-of: Private generic functions

W
with-command: Public macros
with-solid-engine: Public macros
with-variables: Public macros
with-view: Public macros