The routes Reference Manual

Table of Contents

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

The routes Reference Manual

This is the routes Reference Manual, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:15:31 2021 GMT+0.

• Systems  The systems documentation
• Modules  The modules documentation
• Files  The files documentation
• Packages  The packages documentation
• Definitions  The symbols documentation
• Indexes  Concepts, functions, variables and data types

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

1 Systems

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

• The routes system  

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

1.1 routes

Dependencies
Source

routes.asd (file)

Component

src (module)

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

2 Modules

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

• The routes/src module  

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

2.1 routes/src

Parent

routes (system)

Location

src/

Components

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

3 Files

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

• Lisp files  

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

3.1 Lisp

• The routes.asd file  
• The routes/src/package.lisp file  
• The routes/src/uri-template.lisp file  
• The routes/src/route.lisp file  
• The routes/src/mapper.lisp file  

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

3.1.1 routes.asd

Location

routes.asd

Systems

routes (system)

Packages

routes-system

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

3.1.2 routes/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

routes

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

3.1.3 routes/src/uri-template.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/uri-template.lisp

Exported Definitions
Internal Definitions

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

3.1.4 routes/src/route.lisp

Dependency

uri-template.lisp (file)

Parent

src (module)

Location

src/route.lisp

Exported Definitions
Internal Definitions

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

3.1.5 routes/src/mapper.lisp

Dependency

route.lisp (file)

Parent

src (module)

Location

src/mapper.lisp

Exported Definitions

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

4 Packages

Packages are listed by definition order.

• The routes-system package  
• The routes package  

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

4.1 routes-system

Source

routes.asd

Use List

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

4.2 routes

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

5 Definitions

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

• Exported definitions  
• Internal definitions  

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

5.1 Exported definitions

• Exported special variables  
• Exported functions  
• Exported generic functions  
• Exported classes  

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

5.1.1 Special variables

Special Variable: +no-bindings+

Indicates unification success, with no variables.

Package

routes

Source

uri-template.lisp (file)

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

5.1.2 Functions

Function: connect MAP ROUTE
Package

routes

Source

mapper.lisp (file)

Function: make-route TMPL &optional VARSPECS
Package

routes

Source

route.lisp (file)

Function: parse-template TMPL &optional VARSPECS
Package

routes

Source

route.lisp (file)

Function: reset-mapper MAP
Package

routes

Source

mapper.lisp (file)

Function: route-variables ROUTE
Package

routes

Source

route.lisp (file)

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

5.1.3 Generic functions

Generic Function: match MAP URI &optional BINDINGS
Package

routes

Source

mapper.lisp (file)

Methods
Method: match MAP (PATHS cons) &optional BINDINGS
Method: match MAP (ROUTE route) &optional BINDINGS
Method: match MAP (URI uri) &optional BINDINGS
Method: match MAP (URI string) &optional BINDINGS
Method: match MAP (EMPTY (eql nil)) &optional BINDINGS
Generic Function: proxy-route-target OBJECT
Package

routes

Methods
Method: proxy-route-target (PROXY-ROUTE proxy-route)

automatically generated reader method

Source

route.lisp (file)

Generic Function: route-check-conditions ROUTE BINDINGS

Used for check the additional conditions when comparing the ROUTE with the request.

Package

routes

Source

route.lisp (file)

Methods
Method: route-check-conditions (PROXY proxy-route) BINDINGS
Method: route-check-conditions ROUTE BINDINGS
Generic Function: route-name ROUTE

Route name

Package

routes

Source

route.lisp (file)

Methods
Method: route-name (PROXY proxy-route)
Method: route-name ROUTE
Generic Function: route-template ROUTE

Template URI of ROUTE

Package

routes

Source

route.lisp (file)

Methods
Method: route-template (PROXY proxy-route)
Method: route-template (ROUTE route)

automatically generated reader method

Generic Function: template-data OBJECT
Generic Function: (setf template-data) NEW-VALUE OBJECT
Package

routes

Methods
Method: template-data (URI-COMPONENT-TEMPLATE uri-component-template)

automatically generated reader method

Source

uri-template.lisp (file)

Method: (setf template-data) NEW-VALUE (URI-COMPONENT-TEMPLATE uri-component-template)

automatically generated writer method

Source

uri-template.lisp (file)

Generic Function: template-variables TMPL
Package

routes

Source

uri-template.lisp (file)

Methods
Method: template-variables (TMPL wildcard-template)
Method: template-variables (TMPL variable-template)
Method: template-variables TMPL
Method: template-variables (TMPL cons)
Method: template-variables (TMPL uri-component-template)
Generic Function: variable-parse-fun OBJECT
Package

routes

Methods
Method: variable-parse-fun (CUSTOM-TEMPLATE custom-template)

automatically generated reader method

Source

uri-template.lisp (file)

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

5.1.4 Classes

Class: base-route ()
Package

routes

Source

route.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Class: concat-template ()
Package

routes

Source

uri-template.lisp (file)

Direct superclasses

uri-component-template (class)

Direct methods
Class: custom-variable-template ()
Package

routes

Source

uri-template.lisp (file)

Direct superclasses
Class: mapper ()
Package

routes

Source

mapper.lisp (file)

Direct superclasses

standard-object (class)

Direct slots
Slot: template
Initargs

:template

Class: or-template ()
Package

routes

Source

uri-template.lisp (file)

Direct superclasses

uri-component-template (class)

Direct methods
Class: proxy-route ()
Package

routes

Source

route.lisp (file)

Direct superclasses

base-route (class)

Direct methods
Direct slots
Slot: target
Initargs

:target

Readers

proxy-route-target (generic function)

Class: route ()
Package

routes

Source

route.lisp (file)

Direct superclasses

base-route (class)

Direct methods
Direct slots
Slot: template
Initargs

:template

Readers

route-template (generic function)

Class: uri-component-template ()
Package

routes

Source

uri-template.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: spec
Initargs

:spec

Readers

template-data (generic function)

Writers

(setf template-data) (generic function)

Class: variable-template ()
Package

routes

Source

uri-template.lisp (file)

Direct superclasses

uri-component-template (class)

Direct subclasses

custom-variable-template (class)

Direct methods
Class: wildcard-template ()
Package

routes

Source

uri-template.lisp (file)

Direct superclasses

uri-component-template (class)

Direct subclasses

custom-wildcard-template (class)

Direct methods

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

5.2 Internal definitions

• Internal constants  
• Internal special variables  
• Internal macros  
• Internal functions  
• Internal generic functions  
• Internal classes  

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

5.2.1 Constants

Constant: +fail+

Indicates unification failure

Package

routes

Source

uri-template.lisp (file)

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

5.2.2 Special variables

Special Variable: *make-template-map*
Package

routes

Source

uri-template.lisp (file)

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

5.2.3 Macros

Macro: intern-keyword NAME
Package

routes

Source

route.lisp (file)

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

5.2.4 Functions

Function: extend-bindings VAR VAL BINDINGS

Add a (var . value) pair to a binding list.

Package

routes

Source

uri-template.lisp (file)

Function: generate-url ROUTE BINDINGS
Package

routes

Source

route.lisp (file)

Function: get-binding VAR BINDINGS

Find a (variable . value) pair in a binding list.

Package

routes

Source

uri-template.lisp (file)

Function: lookup VAR BINDINGS

Get the value part (for var) from a binding list.

Package

routes

Source

uri-template.lisp (file)

Function: make-concat-template SPEC
Package

routes

Source

uri-template.lisp (file)

Function: make-or-template SPEC
Package

routes

Source

uri-template.lisp (file)

Function: make-unify-template TYPE SPEC
Package

routes

Source

uri-template.lisp (file)

Function: make-variable-template SPEC
Package

routes

Source

uri-template.lisp (file)

Function: make-wildcard-template SPEC
Package

routes

Source

uri-template.lisp (file)

Function: occurs-in-p VAR X BINDINGS

Does var occur anywhere inside x?

Package

routes

Source

uri-template.lisp (file)

Function: parse-path STR &optional VARSPECS
Package

routes

Source

route.lisp (file)

Function: unify X Y &optional BINDINGS
Package

routes

Source

uri-template.lisp (file)

Function: variable-p X
Package

routes

Source

uri-template.lisp (file)

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

5.2.5 Generic functions

Generic Function: apply-bindings TMPL BINDINGS
Package

routes

Source

uri-template.lisp (file)

Methods
Method: apply-bindings (TMPL concat-template) BINDINGS
Method: apply-bindings (VAR wildcard-template) BINDINGS
Method: apply-bindings (VAR variable-template) BINDINGS
Method: apply-bindings (TMPL cons) BINDINGS
Method: apply-bindings (TMPL string) BINDINGS
Method: apply-bindings (TMPL (eql nil)) BINDINGS
Generic Function: merge-uri-templates A B

Merge the templates A and B into one template

Package

routes

Source

uri-template.lisp (file)

Methods
Method: merge-uri-templates (A or-template) (B or-template)
Method: merge-uri-templates (A or-template) B
Method: merge-uri-templates A (B or-template)
Method: merge-uri-templates (A cons) (B cons)
Method: merge-uri-templates A B
Generic Function: unify/impl A B BINDINGS
Package

routes

Source

uri-template.lisp (file)

Methods
Method: unify/impl (A variable-template) (ROUTE base-route) BINDINGS
Source

route.lisp (file)

Method: unify/impl (B base-route) (A variable-template) BINDINGS
Source

route.lisp (file)

Method: unify/impl X Y BINDINGS
Method: unify/impl (TMPL or-template) X BINDINGS
Method: unify/impl A (B or-template) BINDINGS
Method: unify/impl (TMPL concat-template) (STR string) BINDINGS
Method: unify/impl A (B concat-template) BINDINGS
Method: unify/impl (TMPL custom-template) X BINDINGS
Method: unify/impl (TMPL variable-template) X BINDINGS &aux VAR
Method: unify/impl A (B variable-template) BINDINGS
Method: unify/impl (A string) (B string) BINDINGS
Method: unify/impl (A cons) (B cons) BINDINGS
Method: unify/impl (TMPL wildcard-template) X BINDINGS &aux VAR
Generic Function: uri-template-equal A B

Return T if template a and template are equal

Package

routes

Source

uri-template.lisp (file)

Methods
Method: uri-template-equal (A cons) (B cons)
Method: uri-template-equal A (B wildcard-template)
Method: uri-template-equal (A wildcard-template) B
Method: uri-template-equal (A uri-component-template) (B uri-component-template)
Method: uri-template-equal A B

Default implementation

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

5.2.6 Classes

Class: custom-template ()
Package

routes

Source

uri-template.lisp (file)

Direct superclasses

standard-object (class)

Direct subclasses
Direct methods
Direct slots
Slot: parse-fun
Initargs

:parse

Readers

variable-parse-fun (generic function)

Class: custom-wildcard-template ()
Package

routes

Source

uri-template.lisp (file)

Direct superclasses

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

Appendix A Indexes

• Concept index  
• Function index  
• Variable index  
• Data type index  

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

A.1 Concepts

Jump to:   F   L   M   R  
Index Entry  Section
F
File, Lisp, routes.asd: The routes․asd file
File, Lisp, routes/src/mapper.lisp: The routes/src/mapper․lisp file
File, Lisp, routes/src/package.lisp: The routes/src/package․lisp file
File, Lisp, routes/src/route.lisp: The routes/src/route․lisp file
File, Lisp, routes/src/uri-template.lisp: The routes/src/uri-template․lisp file
L
Lisp File, routes.asd: The routes․asd file
Lisp File, routes/src/mapper.lisp: The routes/src/mapper․lisp file
Lisp File, routes/src/package.lisp: The routes/src/package․lisp file
Lisp File, routes/src/route.lisp: The routes/src/route․lisp file
Lisp File, routes/src/uri-template.lisp: The routes/src/uri-template․lisp file
M
Module, routes/src: The routes/src module
R
routes.asd: The routes․asd file
routes/src: The routes/src module
routes/src/mapper.lisp: The routes/src/mapper․lisp file
routes/src/package.lisp: The routes/src/package․lisp file
routes/src/route.lisp: The routes/src/route․lisp file
routes/src/uri-template.lisp: The routes/src/uri-template․lisp file
Jump to:   F   L   M   R  

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

A.2 Functions

Jump to:   (  
A   C   E   F   G   I   L   M   O   P   R   T   U   V  
Index Entry  Section
(
(setf template-data): Exported generic functions
(setf template-data): Exported generic functions
A
apply-bindings: Internal generic functions
apply-bindings: Internal generic functions
apply-bindings: Internal generic functions
apply-bindings: Internal generic functions
apply-bindings: Internal generic functions
apply-bindings: Internal generic functions
apply-bindings: Internal generic functions
C
connect: Exported functions
E
extend-bindings: Internal functions
F
Function, connect: Exported functions
Function, extend-bindings: Internal functions
Function, generate-url: Internal functions
Function, get-binding: Internal functions
Function, lookup: Internal functions
Function, make-concat-template: Internal functions
Function, make-or-template: Internal functions
Function, make-route: Exported functions
Function, make-unify-template: Internal functions
Function, make-variable-template: Internal functions
Function, make-wildcard-template: Internal functions
Function, occurs-in-p: Internal functions
Function, parse-path: Internal functions
Function, parse-template: Exported functions
Function, reset-mapper: Exported functions
Function, route-variables: Exported functions
Function, unify: Internal functions
Function, variable-p: Internal functions
G
generate-url: Internal functions
Generic Function, (setf template-data): Exported generic functions
Generic Function, apply-bindings: Internal generic functions
Generic Function, match: Exported generic functions
Generic Function, merge-uri-templates: Internal generic functions
Generic Function, proxy-route-target: Exported generic functions
Generic Function, route-check-conditions: Exported generic functions
Generic Function, route-name: Exported generic functions
Generic Function, route-template: Exported generic functions
Generic Function, template-data: Exported generic functions
Generic Function, template-variables: Exported generic functions
Generic Function, unify/impl: Internal generic functions
Generic Function, uri-template-equal: Internal generic functions
Generic Function, variable-parse-fun: Exported generic functions
get-binding: Internal functions
I
intern-keyword: Internal macros
L
lookup: Internal functions
M
Macro, intern-keyword: Internal macros
make-concat-template: Internal functions
make-or-template: Internal functions
make-route: Exported functions
make-unify-template: Internal functions
make-variable-template: Internal functions
make-wildcard-template: Internal functions
match: Exported generic functions
match: Exported generic functions
match: Exported generic functions
match: Exported generic functions
match: Exported generic functions
match: Exported generic functions
merge-uri-templates: Internal generic functions
merge-uri-templates: Internal generic functions
merge-uri-templates: Internal generic functions
merge-uri-templates: Internal generic functions
merge-uri-templates: Internal generic functions
merge-uri-templates: Internal generic functions
Method, (setf template-data): Exported generic functions
Method, apply-bindings: Internal generic functions
Method, apply-bindings: Internal generic functions
Method, apply-bindings: Internal generic functions
Method, apply-bindings: Internal generic functions
Method, apply-bindings: Internal generic functions
Method, apply-bindings: Internal generic functions
Method, match: Exported generic functions
Method, match: Exported generic functions
Method, match: Exported generic functions
Method, match: Exported generic functions
Method, match: Exported generic functions
Method, merge-uri-templates: Internal generic functions
Method, merge-uri-templates: Internal generic functions
Method, merge-uri-templates: Internal generic functions
Method, merge-uri-templates: Internal generic functions
Method, merge-uri-templates: Internal generic functions
Method, proxy-route-target: Exported generic functions
Method, route-check-conditions: Exported generic functions
Method, route-check-conditions: Exported generic functions
Method, route-name: Exported generic functions
Method, route-name: Exported generic functions
Method, route-template: Exported generic functions
Method, route-template: Exported generic functions
Method, template-data: Exported generic functions
Method, template-variables: Exported generic functions
Method, template-variables: Exported generic functions
Method, template-variables: Exported generic functions
Method, template-variables: Exported generic functions
Method, template-variables: Exported generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, unify/impl: Internal generic functions
Method, uri-template-equal: Internal generic functions
Method, uri-template-equal: Internal generic functions
Method, uri-template-equal: Internal generic functions
Method, uri-template-equal: Internal generic functions
Method, uri-template-equal: Internal generic functions
Method, variable-parse-fun: Exported generic functions
O
occurs-in-p: Internal functions
P
parse-path: Internal functions
parse-template: Exported functions
proxy-route-target: Exported generic functions
proxy-route-target: Exported generic functions
R
reset-mapper: Exported functions
route-check-conditions: Exported generic functions
route-check-conditions: Exported generic functions
route-check-conditions: Exported generic functions
route-name: Exported generic functions
route-name: Exported generic functions
route-name: Exported generic functions
route-template: Exported generic functions
route-template: Exported generic functions
route-template: Exported generic functions
route-variables: Exported functions
T
template-data: Exported generic functions
template-data: Exported generic functions
template-variables: Exported generic functions
template-variables: Exported generic functions
template-variables: Exported generic functions
template-variables: Exported generic functions
template-variables: Exported generic functions
template-variables: Exported generic functions
U
unify: Internal functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
unify/impl: Internal generic functions
uri-template-equal: Internal generic functions
uri-template-equal: Internal generic functions
uri-template-equal: Internal generic functions
uri-template-equal: Internal generic functions
uri-template-equal: Internal generic functions
uri-template-equal: Internal generic functions
V
variable-p: Internal functions
variable-parse-fun: Exported generic functions
variable-parse-fun: Exported generic functions
Jump to:   (  
A   C   E   F   G   I   L   M   O   P   R   T   U   V  

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

A.3 Variables

Jump to:   *   +  
C   P   S   T  
Index Entry  Section
*
*make-template-map*: Internal special variables
+
+fail+: Internal constants
+no-bindings+: Exported special variables
C
Constant, +fail+: Internal constants
P
parse-fun: Internal classes
S
Slot, parse-fun: Internal classes
Slot, spec: Exported classes
Slot, target: Exported classes
Slot, template: Exported classes
Slot, template: Exported classes
spec: Exported classes
Special Variable, *make-template-map*: Internal special variables
Special Variable, +no-bindings+: Exported special variables
T
target: Exported classes
template: Exported classes
template: Exported classes
Jump to:   *   +  
C   P   S   T  

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

A.4 Data types

Jump to:   B   C   M   O   P   R   S   U   V   W  
Index Entry  Section
B
base-route: Exported classes
C
Class, base-route: Exported classes
Class, concat-template: Exported classes
Class, custom-template: Internal classes
Class, custom-variable-template: Exported classes
Class, custom-wildcard-template: Internal classes
Class, mapper: Exported classes
Class, or-template: Exported classes
Class, proxy-route: Exported classes
Class, route: Exported classes
Class, uri-component-template: Exported classes
Class, variable-template: Exported classes
Class, wildcard-template: Exported classes
concat-template: Exported classes
custom-template: Internal classes
custom-variable-template: Exported classes
custom-wildcard-template: Internal classes
M
mapper: Exported classes
O
or-template: Exported classes
P
Package, routes: The routes package
Package, routes-system: The routes-system package
proxy-route: Exported classes
R
route: Exported classes
routes: The routes system
routes: The routes package
routes-system: The routes-system package
S
System, routes: The routes system
U
uri-component-template: Exported classes
V
variable-template: Exported classes
W
wildcard-template: Exported classes
Jump to:   B   C   M   O   P   R   S   U   V   W