The trivial-variable-bindings Reference Manual

Table of Contents

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

The trivial-variable-bindings Reference Manual

This is the trivial-variable-bindings Reference Manual, version 0.1.6, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Mon Jul 29 16:52:46 2019 GMT+0.


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

1 Introduction

Trivial Variable Bindings Manual

[in package TRIVIAL-VARIABLE-BINDINGS]

pipeline status Quicklisp coverage report

Description

This simple library offers a way to handle associations between a place-holder (aka. variable) and a value. See trivial-filter for an application.

Installing trivial-variable-bindings

This project is available in the latest QuickLisp distribution, so installing it is reduced to calling:

(ql:quickload :trivial-variable-bindings)

Working Example

See trivial-filter for an application.

Exported Symbols

License Information

This library is released under the MIT License. Please refer to the LICENSE to get the full licensing text.

Contributing to this project

Please refer to the CONTRIBUTING document for more information.


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 trivial-variable-bindings

Author

Eric Diethelm <ediethelm@yahoo.com>

License

MIT

Description

Offers a way to handle associations between a place-holder (aka. variable) and a value.

Version

0.1.6

Dependencies
Source

trivial-variable-bindings.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 trivial-variable-bindings.asd

Location

trivial-variable-bindings.asd

Systems

trivial-variable-bindings (system)


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

3.1.2 trivial-variable-bindings/package.lisp

Parent

trivial-variable-bindings (system)

Location

package.lisp

Packages

trivial-variable-bindings


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

3.1.3 trivial-variable-bindings/trivial-variable-bindings.lisp

Parent

trivial-variable-bindings (system)

Location

trivial-variable-bindings.lisp

Exported Definitions

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

3.1.4 trivial-variable-bindings/documentation.lisp

Parent

trivial-variable-bindings (system)

Location

documentation.lisp

Exported Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 trivial-variable-bindings

Source

package.lisp (file)

Use List
Exported Definitions

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

5 Definitions

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


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

5.1 Exported definitions


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

5.1.1 Special variables

Special Variable: @trivial-variable-bindings-contributing
Package

trivial-variable-bindings

Source

documentation.lisp (file)

Special Variable: @trivial-variable-bindings-description
Package

trivial-variable-bindings

Source

documentation.lisp (file)

Special Variable: @trivial-variable-bindings-example
Package

trivial-variable-bindings

Source

documentation.lisp (file)

Special Variable: @trivial-variable-bindings-exported
Package

trivial-variable-bindings

Source

documentation.lisp (file)

Special Variable: @trivial-variable-bindings-installing
Package

trivial-variable-bindings

Source

documentation.lisp (file)

Special Variable: @trivial-variable-bindings-license
Package

trivial-variable-bindings

Source

documentation.lisp (file)

Special Variable: @trivial-variable-bindings-manual
Package

trivial-variable-bindings

Source

documentation.lisp (file)


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

5.1.2 Functions

Function: bound-variable-value VAR BINDINGS

Return the value associated to the *place-holder* **VAR** in the *bindings* container **BINDINGS**, if any. Otherwise return the *place-holder* **VAR** itself.

Package

trivial-variable-bindings

Source

trivial-variable-bindings.lisp (file)

Writer

(setf bound-variable-value) (function)

Function: (setf bound-variable-value) VALUE VAR BINDINGS
Package

trivial-variable-bindings

Source

trivial-variable-bindings.lisp (file)

Reader

bound-variable-value (function)

Function: contains VAR BINDINGS

Verify that a *place-holder* **VAR** is bound to a specific value in the *bindings* container **BINDINGS**.

Package

trivial-variable-bindings

Source

trivial-variable-bindings.lisp (file)

Function: remove-bound-variable VAR BINDINGS

Delete the bound *place-holder* **VAR** in the *bindings* container **BINDINGS**.

Package

trivial-variable-bindings

Source

trivial-variable-bindings.lisp (file)


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

5.1.3 Generic functions

Generic Function: bound-value OBJECT
Generic Function: (setf bound-value) NEW-VALUE OBJECT
Package

trivial-variable-bindings

Methods
Method: bound-value (VARIABLE-BINDING variable-binding)

automatically generated reader method

Source

trivial-variable-bindings.lisp (file)

Method: (setf bound-value) NEW-VALUE (VARIABLE-BINDING variable-binding)

automatically generated writer method

Source

trivial-variable-bindings.lisp (file)

Generic Function: bound-variable OBJECT
Package

trivial-variable-bindings

Methods
Method: bound-variable (VARIABLE-BINDING variable-binding)

automatically generated reader method

Source

trivial-variable-bindings.lisp (file)

Generic Function: bound-variables OBJECT
Generic Function: (setf bound-variables) NEW-VALUE OBJECT
Package

trivial-variable-bindings

Methods
Method: bound-variables (BINDINGS bindings)

automatically generated reader method

Source

trivial-variable-bindings.lisp (file)

Method: (setf bound-variables) NEW-VALUE (BINDINGS bindings)

automatically generated writer method

Source

trivial-variable-bindings.lisp (file)

Generic Function: place-holder-name OBJECT
Package

trivial-variable-bindings

Methods
Method: place-holder-name (PLACE-HOLDER place-holder)

automatically generated reader method

Source

trivial-variable-bindings.lisp (file)


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

5.1.4 Classes

Class: bindings ()

A set of named variabled bound to corresponding values.

Package

trivial-variable-bindings

Source

trivial-variable-bindings.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • clone (method)
  • print-object (method)
  • equals (method)
  • bound-variables (method)
  • bound-variables (method)
Direct slots
Slot: bound-variables
Type

list

Initargs

:bound-variables

Readers

bound-variables (generic function)

Writers

(setf bound-variables) (generic function)

Class: place-holder ()

A named variable.

Package

trivial-variable-bindings

Source

trivial-variable-bindings.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: name
Initargs

:name

Readers

place-holder-name (generic function)

Class: variable-binding ()

The binding of a named variable to a specific value.

Package

trivial-variable-bindings

Source

trivial-variable-bindings.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
Direct slots
Slot: variable
Type

trivial-variable-bindings:place-holder

Initargs

:bound-variable

Readers

bound-variable (generic function)

Slot: value
Initargs

:bound-value

Readers

bound-value (generic function)

Writers

(setf bound-value) (generic function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   T  
Index Entry  Section

F
File, Lisp, trivial-variable-bindings.asd: The trivial-variable-bindings<dot>asd file
File, Lisp, trivial-variable-bindings/documentation.lisp: The trivial-variable-bindings/documentation<dot>lisp file
File, Lisp, trivial-variable-bindings/package.lisp: The trivial-variable-bindings/package<dot>lisp file
File, Lisp, trivial-variable-bindings/trivial-variable-bindings.lisp: The trivial-variable-bindings/trivial-variable-bindings<dot>lisp file

L
Lisp File, trivial-variable-bindings.asd: The trivial-variable-bindings<dot>asd file
Lisp File, trivial-variable-bindings/documentation.lisp: The trivial-variable-bindings/documentation<dot>lisp file
Lisp File, trivial-variable-bindings/package.lisp: The trivial-variable-bindings/package<dot>lisp file
Lisp File, trivial-variable-bindings/trivial-variable-bindings.lisp: The trivial-variable-bindings/trivial-variable-bindings<dot>lisp file

T
trivial-variable-bindings.asd: The trivial-variable-bindings<dot>asd file
trivial-variable-bindings/documentation.lisp: The trivial-variable-bindings/documentation<dot>lisp file
trivial-variable-bindings/package.lisp: The trivial-variable-bindings/package<dot>lisp file
trivial-variable-bindings/trivial-variable-bindings.lisp: The trivial-variable-bindings/trivial-variable-bindings<dot>lisp file

Jump to:   F   L   T  

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

A.2 Functions

Jump to:   (  
B   C   F   G   M   P   R  
Index Entry  Section

(
(setf bound-value): Exported generic functions
(setf bound-value): Exported generic functions
(setf bound-variable-value): Exported functions
(setf bound-variables): Exported generic functions
(setf bound-variables): Exported generic functions

B
bound-value: Exported generic functions
bound-value: Exported generic functions
bound-variable: Exported generic functions
bound-variable: Exported generic functions
bound-variable-value: Exported functions
bound-variables: Exported generic functions
bound-variables: Exported generic functions

C
contains: Exported functions

F
Function, (setf bound-variable-value): Exported functions
Function, bound-variable-value: Exported functions
Function, contains: Exported functions
Function, remove-bound-variable: Exported functions

G
Generic Function, (setf bound-value): Exported generic functions
Generic Function, (setf bound-variables): Exported generic functions
Generic Function, bound-value: Exported generic functions
Generic Function, bound-variable: Exported generic functions
Generic Function, bound-variables: Exported generic functions
Generic Function, place-holder-name: Exported generic functions

M
Method, (setf bound-value): Exported generic functions
Method, (setf bound-variables): Exported generic functions
Method, bound-value: Exported generic functions
Method, bound-variable: Exported generic functions
Method, bound-variables: Exported generic functions
Method, place-holder-name: Exported generic functions

P
place-holder-name: Exported generic functions
place-holder-name: Exported generic functions

R
remove-bound-variable: Exported functions

Jump to:   (  
B   C   F   G   M   P   R  

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

A.3 Variables

Jump to:   @  
B   N   S   V  
Index Entry  Section

@
@trivial-variable-bindings-contributing: Exported special variables
@trivial-variable-bindings-description: Exported special variables
@trivial-variable-bindings-example: Exported special variables
@trivial-variable-bindings-exported: Exported special variables
@trivial-variable-bindings-installing: Exported special variables
@trivial-variable-bindings-license: Exported special variables
@trivial-variable-bindings-manual: Exported special variables

B
bound-variables: Exported classes

N
name: Exported classes

S
Slot, bound-variables: Exported classes
Slot, name: Exported classes
Slot, value: Exported classes
Slot, variable: Exported classes
Special Variable, @trivial-variable-bindings-contributing: Exported special variables
Special Variable, @trivial-variable-bindings-description: Exported special variables
Special Variable, @trivial-variable-bindings-example: Exported special variables
Special Variable, @trivial-variable-bindings-exported: Exported special variables
Special Variable, @trivial-variable-bindings-installing: Exported special variables
Special Variable, @trivial-variable-bindings-license: Exported special variables
Special Variable, @trivial-variable-bindings-manual: Exported special variables

V
value: Exported classes
variable: Exported classes

Jump to:   @  
B   N   S   V  

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

A.4 Data types

Jump to:   B   C   P   S   T   V  
Index Entry  Section

B
bindings: Exported classes

C
Class, bindings: Exported classes
Class, place-holder: Exported classes
Class, variable-binding: Exported classes

P
Package, trivial-variable-bindings: The trivial-variable-bindings package
place-holder: Exported classes

S
System, trivial-variable-bindings: The trivial-variable-bindings system

T
trivial-variable-bindings: The trivial-variable-bindings system
trivial-variable-bindings: The trivial-variable-bindings package

V
variable-binding: Exported classes

Jump to:   B   C   P   S   T   V