The routes Reference Manual

This is the routes Reference Manual, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 04:25:55 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 routes

Dependencies
  • puri (system).
  • iterate (system).
  • split-sequence (system).
Source

routes.asd.

Child Component

src (module).


2 Modules

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


2.1 routes/src

Source

routes.asd.

Parent Component

routes (system).

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 routes/routes.asd

Source

routes.asd.

Parent Component

routes (system).

ASDF Systems

routes.

Packages

routes-system.


3.1.2 routes/src/package.lisp

Source

routes.asd.

Parent Component

src (module).

Packages

routes.


3.1.3 routes/src/uri-template.lisp

Dependency

package.lisp (file).

Source

routes.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.4 routes/src/route.lisp

Dependency

uri-template.lisp (file).

Source

routes.asd.

Parent Component

src (module).

Public Interface
Internals

3.1.5 routes/src/mapper.lisp

Dependency

route.lisp (file).

Source

routes.asd.

Parent Component

src (module).

Public Interface

4 Packages

Packages are listed by definition order.


4.1 routes

Source

package.lisp.

Use List
  • common-lisp.
  • iterate.
  • split-sequence.
Public Interface
Internals

4.2 routes-system

Source

routes.asd.

Use List
  • asdf/interface.
  • common-lisp.

5 Definitions

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


5.1 Public Interface


5.1.1 Special variables

Special Variable: +no-bindings+

Indicates unification success, with no variables.

Package

routes.

Source

uri-template.lisp.


5.1.2 Ordinary functions

Function: connect (map route)
Package

routes.

Source

mapper.lisp.

Function: make-route (tmpl &optional varspecs)
Package

routes.

Source

route.lisp.

Function: parse-template (tmpl &optional varspecs)
Package

routes.

Source

route.lisp.

Function: reset-mapper (map)
Package

routes.

Source

mapper.lisp.

Function: route-variables (route)
Package

routes.

Source

route.lisp.


5.1.3 Generic functions

Generic Function: match (map uri &optional bindings)
Package

routes.

Source

mapper.lisp.

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 Reader: proxy-route-target (object)
Package

routes.

Methods
Reader Method: proxy-route-target ((proxy-route proxy-route))

automatically generated reader method

Source

route.lisp.

Target Slot

target.

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.

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.

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.

Methods
Method: route-template ((proxy proxy-route))
Reader Method: route-template ((route route))

automatically generated reader method

Target Slot

template.

Generic Reader: template-data (object)
Package

routes.

Methods
Reader Method: template-data ((uri-component-template uri-component-template))

automatically generated reader method

Source

uri-template.lisp.

Target Slot

spec.

Generic Writer: (setf template-data) (object)
Package

routes.

Methods
Writer Method: (setf template-data) ((uri-component-template uri-component-template))

automatically generated writer method

Source

uri-template.lisp.

Target Slot

spec.

Generic Function: template-variables (tmpl)
Package

routes.

Source

uri-template.lisp.

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 Reader: variable-parse-fun (object)
Package

routes.

Methods
Reader Method: variable-parse-fun ((custom-template custom-template))

automatically generated reader method

Source

uri-template.lisp.

Target Slot

parse-fun.


5.1.4 Classes

Class: base-route
Package

routes.

Source

route.lisp.

Direct subclasses
Direct methods
Class: concat-template
Package

routes.

Source

uri-template.lisp.

Direct superclasses

uri-component-template.

Direct methods
Class: custom-variable-template
Package

routes.

Source

uri-template.lisp.

Direct superclasses
Class: mapper
Package

routes.

Source

mapper.lisp.

Direct slots
Slot: template
Initargs

:template

Class: or-template
Package

routes.

Source

uri-template.lisp.

Direct superclasses

uri-component-template.

Direct methods
Class: proxy-route
Package

routes.

Source

route.lisp.

Direct superclasses

base-route.

Direct methods
Direct slots
Slot: target
Initargs

:target

Readers

proxy-route-target.

Writers

This slot is read-only.

Class: route
Package

routes.

Source

route.lisp.

Direct superclasses

base-route.

Direct methods
Direct slots
Slot: template
Initargs

:template

Readers

route-template.

Writers

This slot is read-only.

Class: uri-component-template
Package

routes.

Source

uri-template.lisp.

Direct subclasses
Direct methods
Direct slots
Slot: spec
Initargs

:spec

Readers

template-data.

Writers

(setf template-data).

Class: variable-template
Package

routes.

Source

uri-template.lisp.

Direct superclasses

uri-component-template.

Direct subclasses

custom-variable-template.

Direct methods
Class: wildcard-template
Package

routes.

Source

uri-template.lisp.

Direct superclasses

uri-component-template.

Direct subclasses

custom-wildcard-template.

Direct methods

5.2 Internals


5.2.1 Constants

Constant: +fail+

Indicates unification failure

Package

routes.

Source

uri-template.lisp.


5.2.2 Special variables

Special Variable: *make-template-map*
Package

routes.

Source

uri-template.lisp.


5.2.3 Macros

Macro: intern-keyword (name)
Package

routes.

Source

route.lisp.


5.2.4 Ordinary functions

Function: extend-bindings (var val bindings)

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

Package

routes.

Source

uri-template.lisp.

Function: generate-url (route bindings)
Package

routes.

Source

route.lisp.

Function: get-binding (var bindings)

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

Package

routes.

Source

uri-template.lisp.

Function: lookup (var bindings)

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

Package

routes.

Source

uri-template.lisp.

Function: make-concat-template (spec)
Package

routes.

Source

uri-template.lisp.

Function: make-or-template (spec)
Package

routes.

Source

uri-template.lisp.

Function: make-unify-template (type spec)
Package

routes.

Source

uri-template.lisp.

Function: make-variable-template (spec)
Package

routes.

Source

uri-template.lisp.

Function: make-wildcard-template (spec)
Package

routes.

Source

uri-template.lisp.

Function: occurs-in-p (var x bindings)

Does var occur anywhere inside x?

Package

routes.

Source

uri-template.lisp.

Function: parse-path (str &optional varspecs)
Package

routes.

Source

route.lisp.

Function: unify (x y &optional bindings)
Package

routes.

Source

uri-template.lisp.

Function: variable-p (x)
Package

routes.

Source

uri-template.lisp.


5.2.5 Generic functions

Generic Function: apply-bindings (tmpl bindings)
Package

routes.

Source

uri-template.lisp.

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.

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.

Methods
Method: unify/impl ((a variable-template) (route base-route) bindings)
Source

route.lisp.

Method: unify/impl ((b base-route) (a variable-template) bindings)
Source

route.lisp.

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)
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)
Generic Function: uri-template-equal (a b)

Return T if template a and template are equal

Package

routes.

Source

uri-template.lisp.

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


5.2.6 Classes

Class: custom-template
Package

routes.

Source

uri-template.lisp.

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

:parse

Readers

variable-parse-fun.

Writers

This slot is read-only.

Class: custom-wildcard-template
Package

routes.

Source

uri-template.lisp.

Direct superclasses

Appendix A Indexes


A.1 Concepts


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): Public generic functions
(setf template-data): Public generic functions

A
apply-bindings: Private generic functions
apply-bindings: Private generic functions
apply-bindings: Private generic functions
apply-bindings: Private generic functions
apply-bindings: Private generic functions
apply-bindings: Private generic functions
apply-bindings: Private generic functions

C
connect: Public ordinary functions

E
extend-bindings: Private ordinary functions

F
Function, connect: Public ordinary functions
Function, extend-bindings: Private ordinary functions
Function, generate-url: Private ordinary functions
Function, get-binding: Private ordinary functions
Function, lookup: Private ordinary functions
Function, make-concat-template: Private ordinary functions
Function, make-or-template: Private ordinary functions
Function, make-route: Public ordinary functions
Function, make-unify-template: Private ordinary functions
Function, make-variable-template: Private ordinary functions
Function, make-wildcard-template: Private ordinary functions
Function, occurs-in-p: Private ordinary functions
Function, parse-path: Private ordinary functions
Function, parse-template: Public ordinary functions
Function, reset-mapper: Public ordinary functions
Function, route-variables: Public ordinary functions
Function, unify: Private ordinary functions
Function, variable-p: Private ordinary functions

G
generate-url: Private ordinary functions
Generic Function, (setf template-data): Public generic functions
Generic Function, apply-bindings: Private generic functions
Generic Function, match: Public generic functions
Generic Function, merge-uri-templates: Private generic functions
Generic Function, proxy-route-target: Public generic functions
Generic Function, route-check-conditions: Public generic functions
Generic Function, route-name: Public generic functions
Generic Function, route-template: Public generic functions
Generic Function, template-data: Public generic functions
Generic Function, template-variables: Public generic functions
Generic Function, unify/impl: Private generic functions
Generic Function, uri-template-equal: Private generic functions
Generic Function, variable-parse-fun: Public generic functions
get-binding: Private ordinary functions

I
intern-keyword: Private macros

L
lookup: Private ordinary functions

M
Macro, intern-keyword: Private macros
make-concat-template: Private ordinary functions
make-or-template: Private ordinary functions
make-route: Public ordinary functions
make-unify-template: Private ordinary functions
make-variable-template: Private ordinary functions
make-wildcard-template: Private ordinary functions
match: Public generic functions
match: Public generic functions
match: Public generic functions
match: Public generic functions
match: Public generic functions
match: Public generic functions
merge-uri-templates: Private generic functions
merge-uri-templates: Private generic functions
merge-uri-templates: Private generic functions
merge-uri-templates: Private generic functions
merge-uri-templates: Private generic functions
merge-uri-templates: Private generic functions
Method, (setf template-data): Public generic functions
Method, apply-bindings: Private generic functions
Method, apply-bindings: Private generic functions
Method, apply-bindings: Private generic functions
Method, apply-bindings: Private generic functions
Method, apply-bindings: Private generic functions
Method, apply-bindings: Private generic functions
Method, match: Public generic functions
Method, match: Public generic functions
Method, match: Public generic functions
Method, match: Public generic functions
Method, match: Public generic functions
Method, merge-uri-templates: Private generic functions
Method, merge-uri-templates: Private generic functions
Method, merge-uri-templates: Private generic functions
Method, merge-uri-templates: Private generic functions
Method, merge-uri-templates: Private generic functions
Method, proxy-route-target: Public generic functions
Method, route-check-conditions: Public generic functions
Method, route-check-conditions: Public generic functions
Method, route-name: Public generic functions
Method, route-name: Public generic functions
Method, route-template: Public generic functions
Method, route-template: Public generic functions
Method, template-data: Public generic functions
Method, template-variables: Public generic functions
Method, template-variables: Public generic functions
Method, template-variables: Public generic functions
Method, template-variables: Public generic functions
Method, template-variables: Public generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, unify/impl: Private generic functions
Method, uri-template-equal: Private generic functions
Method, uri-template-equal: Private generic functions
Method, uri-template-equal: Private generic functions
Method, uri-template-equal: Private generic functions
Method, uri-template-equal: Private generic functions
Method, variable-parse-fun: Public generic functions

O
occurs-in-p: Private ordinary functions

P
parse-path: Private ordinary functions
parse-template: Public ordinary functions
proxy-route-target: Public generic functions
proxy-route-target: Public generic functions

R
reset-mapper: Public ordinary functions
route-check-conditions: Public generic functions
route-check-conditions: Public generic functions
route-check-conditions: Public generic functions
route-name: Public generic functions
route-name: Public generic functions
route-name: Public generic functions
route-template: Public generic functions
route-template: Public generic functions
route-template: Public generic functions
route-variables: Public ordinary functions

T
template-data: Public generic functions
template-data: Public generic functions
template-variables: Public generic functions
template-variables: Public generic functions
template-variables: Public generic functions
template-variables: Public generic functions
template-variables: Public generic functions
template-variables: Public generic functions

U
unify: Private ordinary functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
unify/impl: Private generic functions
uri-template-equal: Private generic functions
uri-template-equal: Private generic functions
uri-template-equal: Private generic functions
uri-template-equal: Private generic functions
uri-template-equal: Private generic functions
uri-template-equal: Private generic functions

V
variable-p: Private ordinary functions
variable-parse-fun: Public generic functions
variable-parse-fun: Public generic functions


A.4 Data types

Jump to:   B   C   F   M   O   P   R   S   U   V   W  
Index Entry  Section

B
base-route: Public classes

C
Class, base-route: Public classes
Class, concat-template: Public classes
Class, custom-template: Private classes
Class, custom-variable-template: Public classes
Class, custom-wildcard-template: Private classes
Class, mapper: Public classes
Class, or-template: Public classes
Class, proxy-route: Public classes
Class, route: Public classes
Class, uri-component-template: Public classes
Class, variable-template: Public classes
Class, wildcard-template: Public classes
concat-template: Public classes
custom-template: Private classes
custom-variable-template: Public classes
custom-wildcard-template: Private classes

F
File, mapper.lisp: The routes/src/mapper․lisp file
File, package.lisp: The routes/src/package․lisp file
File, route.lisp: The routes/src/route․lisp file
File, routes.asd: The routes/routes․asd file
File, uri-template.lisp: The routes/src/uri-template․lisp file

M
mapper: Public classes
mapper.lisp: The routes/src/mapper․lisp file
Module, src: The routes/src module

O
or-template: Public classes

P
Package, routes: The routes package
Package, routes-system: The routes-system package
package.lisp: The routes/src/package․lisp file
proxy-route: Public classes

R
route: Public classes
route.lisp: The routes/src/route․lisp file
routes: The routes system
routes: The routes package
routes-system: The routes-system package
routes.asd: The routes/routes․asd file

S
src: The routes/src module
System, routes: The routes system

U
uri-component-template: Public classes
uri-template.lisp: The routes/src/uri-template․lisp file

V
variable-template: Public classes

W
wildcard-template: Public classes