The froute Reference Manual

Table of Contents

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

The froute Reference Manual

This is the froute Reference Manual, version 0.1, generated automatically by Declt version 2.4 patchlevel 1 "Will Decker" on Fri May 24 08:52:24 2019 GMT+0.


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

1 Systems

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


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

1.1 froute

Author

Fungus Humungus

License

MIT

Description

An Http routing class that takes advantage of the MOP

Version

0.1

Dependencies
Source

froute.asd (file)

Component

src (module)


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

2 Modules

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


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

2.1 froute/src

Parent

froute (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.


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

3.1 Lisp


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

3.1.1 froute.asd

Location

froute.asd

Systems

froute (system)

Packages

froute-system


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

3.1.2 froute/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

froute


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

3.1.3 froute/src/froute-class.lisp

Dependency

package.lisp (file)

Parent

src (module)

Location

src/froute-class.lisp

Exported Definitions
Internal Definitions

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

3.1.4 froute/src/routes.lisp

Dependencies
Parent

src (module)

Location

src/routes.lisp

Internal Definitions

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

3.1.5 froute/src/invoke-route.lisp

Dependencies
Parent

src (module)

Location

src/invoke-route.lisp

Exported Definitions

invoke-route (function)

Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 froute-system

Source

froute.asd

Use List

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

4.2 froute

Source

package.lisp (file)

Use List

closer-common-lisp

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.


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

5.1 Exported definitions


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

5.1.1 Functions

Function: invoke-route PATH &key METHOD
Package

froute

Source

invoke-route.lisp (file)


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

5.1.2 Generic functions

Generic Function: run ROUTE METHOD

Generic method that gets run on a matching route.

Package

froute

Source

froute-class.lisp (file)


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

5.1.3 Classes

Class: froute-class ()
Package

froute

Source

froute-class.lisp (file)

Direct superclasses

standard-class (class)

Direct methods
Direct slots
Slot: route
Initargs

:route

Readers

route (generic function)

Writers

(setf route) (generic function)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: *route-classes*
Package

froute

Source

froute-class.lisp (file)

Special Variable: *routes*
Package

froute

Source

froute-class.lisp (file)


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

5.2.2 Functions

Function: add-to-vars VAR PATH VARS
Package

froute

Source

invoke-route.lisp (file)

Function: build-routes ()

Clears our routes mapping and builds it up from scratch.

Package

froute

Source

routes.lisp (file)

Function: copy-route INSTANCE
Package

froute

Source

routes.lisp (file)

Function: create-route-instance CLASS PARAMS

Creates the route class and populates its slots with the variables.

Package

froute

Source

invoke-route.lisp (file)

Function: find-route PATH LIST

Finds the route with the path in the given list

Package

froute

Source

routes.lisp (file)

Function: insert-into-position VALUE LIST &key TEST KEY

Insert the value into the list where every item that fails the test preceeds the value and every item that passes the test follows.

Package

froute

Source

routes.lisp (file)

Function: is-variable-param SEGMENT

Is this route segment a variable (does it start with :)

Package

froute

Source

invoke-route.lisp (file)

Function: is-wildcard-variable SEGMENT

Is this route segment a wildcard. ie Should it return the rest of the route?

Package

froute

Source

invoke-route.lisp (file)

Function: join-segments SEGMENTS

Rejoin the segments separated by /

Package

froute

Source

invoke-route.lisp (file)

Function: make-keyword STR
Package

froute

Source

invoke-route.lisp (file)

Function: make-route &key (PATH PATH) (CLASS CLASS) (CHILDREN CHILDREN)
Package

froute

Source

routes.lisp (file)

Function: match-segments ROUTE PATH VARS
Package

froute

Source

invoke-route.lisp (file)

Function: remove-wildcard SEGMENT

Removes the * from the end of the var

Package

froute

Source

invoke-route.lisp (file)

Function: route-children INSTANCE
Function: (setf route-children) VALUE INSTANCE
Package

froute

Source

routes.lisp (file)

Function: route-class INSTANCE
Function: (setf route-class) VALUE INSTANCE
Package

froute

Source

routes.lisp (file)

Function: route-matches ROUTE METHOD REQUEST-ROUTE REQUEST-METHOD
Package

froute

Source

invoke-route.lisp (file)

Function: route-p OBJECT
Package

froute

Source

routes.lisp (file)

Function: route-path INSTANCE
Function: (setf route-path) VALUE INSTANCE
Package

froute

Source

routes.lisp (file)

Function: split-route ROUTE

Splits the route up into its constituent parts.

Package

froute

Source

invoke-route.lisp (file)

Function: trim-slashes ROUTE

Removes leading and trailing /

Package

froute

Source

invoke-route.lisp (file)

Function: walk-routes PATH METHOD ROUTES VARS

Walk down the routes tree matching the paths and collecting any variables along the way.

Package

froute

Source

invoke-route.lisp (file)


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

5.2.3 Generic functions

Generic Function: clean-route CLASS
Package

froute

Methods
Method: clean-route (CLASS froute-class)

Removes all instances of the given class from our route tree

Source

routes.lisp (file)

Generic Function: collect-inherited-routes CLASS
Package

froute

Methods
Method: collect-inherited-routes (CLASS froute-class)

Retrieves all routes in the inheritance tree that are froutes.

Source

routes.lisp (file)

Generic Function: num-segments ROUTE
Package

froute

Methods
Method: num-segments (ROUTE route)
Source

routes.lisp (file)

Generic Function: push-route CLASS
Package

froute

Methods
Method: push-route (CLASS froute-class)

Pushes a new route into our route tree

Source

routes.lisp (file)

Generic Function: route OBJECT
Generic Function: (setf route) NEW-VALUE OBJECT
Package

froute

Methods
Method: route (FROUTE-CLASS froute-class)

automatically generated reader method

Source

froute-class.lisp (file)

Method: (setf route) NEW-VALUE (FROUTE-CLASS froute-class)

automatically generated writer method

Source

froute-class.lisp (file)


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

5.2.4 Structures

Structure: route ()
Package

froute

Source

routes.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

num-segments (method)

Direct slots
Slot: path
Readers

route-path (function)

Writers

(setf route-path) (function)

Slot: class
Readers

route-class (function)

Writers

(setf route-class) (function)

Slot: children
Readers

route-children (function)

Writers

(setf route-children) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   M  
Index Entry  Section

F
File, Lisp, froute.asd: The froute<dot>asd file
File, Lisp, froute/src/froute-class.lisp: The froute/src/froute-class<dot>lisp file
File, Lisp, froute/src/invoke-route.lisp: The froute/src/invoke-route<dot>lisp file
File, Lisp, froute/src/package.lisp: The froute/src/package<dot>lisp file
File, Lisp, froute/src/routes.lisp: The froute/src/routes<dot>lisp file
froute.asd: The froute<dot>asd file
froute/src: The froute/src module
froute/src/froute-class.lisp: The froute/src/froute-class<dot>lisp file
froute/src/invoke-route.lisp: The froute/src/invoke-route<dot>lisp file
froute/src/package.lisp: The froute/src/package<dot>lisp file
froute/src/routes.lisp: The froute/src/routes<dot>lisp file

L
Lisp File, froute.asd: The froute<dot>asd file
Lisp File, froute/src/froute-class.lisp: The froute/src/froute-class<dot>lisp file
Lisp File, froute/src/invoke-route.lisp: The froute/src/invoke-route<dot>lisp file
Lisp File, froute/src/package.lisp: The froute/src/package<dot>lisp file
Lisp File, froute/src/routes.lisp: The froute/src/routes<dot>lisp file

M
Module, froute/src: The froute/src module

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   (  
A   B   C   F   G   I   J   M   N   P   R   S   T   W  
Index Entry  Section

(
(setf route): Internal generic functions
(setf route): Internal generic functions
(setf route-children): Internal functions
(setf route-class): Internal functions
(setf route-path): Internal functions

A
add-to-vars: Internal functions

B
build-routes: Internal functions

C
clean-route: Internal generic functions
clean-route: Internal generic functions
collect-inherited-routes: Internal generic functions
collect-inherited-routes: Internal generic functions
copy-route: Internal functions
create-route-instance: Internal functions

F
find-route: Internal functions
Function, (setf route-children): Internal functions
Function, (setf route-class): Internal functions
Function, (setf route-path): Internal functions
Function, add-to-vars: Internal functions
Function, build-routes: Internal functions
Function, copy-route: Internal functions
Function, create-route-instance: Internal functions
Function, find-route: Internal functions
Function, insert-into-position: Internal functions
Function, invoke-route: Exported functions
Function, is-variable-param: Internal functions
Function, is-wildcard-variable: Internal functions
Function, join-segments: Internal functions
Function, make-keyword: Internal functions
Function, make-route: Internal functions
Function, match-segments: Internal functions
Function, remove-wildcard: Internal functions
Function, route-children: Internal functions
Function, route-class: Internal functions
Function, route-matches: Internal functions
Function, route-p: Internal functions
Function, route-path: Internal functions
Function, split-route: Internal functions
Function, trim-slashes: Internal functions
Function, walk-routes: Internal functions

G
Generic Function, (setf route): Internal generic functions
Generic Function, clean-route: Internal generic functions
Generic Function, collect-inherited-routes: Internal generic functions
Generic Function, num-segments: Internal generic functions
Generic Function, push-route: Internal generic functions
Generic Function, route: Internal generic functions
Generic Function, run: Exported generic functions

I
insert-into-position: Internal functions
invoke-route: Exported functions
is-variable-param: Internal functions
is-wildcard-variable: Internal functions

J
join-segments: Internal functions

M
make-keyword: Internal functions
make-route: Internal functions
match-segments: Internal functions
Method, (setf route): Internal generic functions
Method, clean-route: Internal generic functions
Method, collect-inherited-routes: Internal generic functions
Method, num-segments: Internal generic functions
Method, push-route: Internal generic functions
Method, route: Internal generic functions

N
num-segments: Internal generic functions
num-segments: Internal generic functions

P
push-route: Internal generic functions
push-route: Internal generic functions

R
remove-wildcard: Internal functions
route: Internal generic functions
route: Internal generic functions
route-children: Internal functions
route-class: Internal functions
route-matches: Internal functions
route-p: Internal functions
route-path: Internal functions
run: Exported generic functions

S
split-route: Internal functions

T
trim-slashes: Internal functions

W
walk-routes: Internal functions

Jump to:   (  
A   B   C   F   G   I   J   M   N   P   R   S   T   W  

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

A.3 Variables

Jump to:   *  
C   P   R   S  
Index Entry  Section

*
*route-classes*: Internal special variables
*routes*: Internal special variables

C
children: Internal structures
class: Internal structures

P
path: Internal structures

R
route: Exported classes

S
Slot, children: Internal structures
Slot, class: Internal structures
Slot, path: Internal structures
Slot, route: Exported classes
Special Variable, *route-classes*: Internal special variables
Special Variable, *routes*: Internal special variables

Jump to:   *  
C   P   R   S  

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

A.4 Data types

Jump to:   C   F   P   R   S  
Index Entry  Section

C
Class, froute-class: Exported classes

F
froute: The froute system
froute: The froute package
froute-class: Exported classes
froute-system: The froute-system package

P
Package, froute: The froute package
Package, froute-system: The froute-system package

R
route: Internal structures

S
Structure, route: Internal structures
System, froute: The froute system

Jump to:   C   F   P   R   S