The froute Reference Manual

3.1.1 froute/froute.asd

Source

froute.asd.

Parent Component

froute (system).

ASDF Systems

froute.

Packages

froute-system.

---

3.1.2 froute/src/package.lisp

Source

froute.asd.

Parent Component

src (module).

Packages

froute.

---

3.1.3 froute/src/froute-class.lisp

Dependency

package.lisp (file).

Source

froute.asd.

Parent Component

src (module).

Public Interface

• froute-class (class).
• initialize-instance (method).
• reinitialize-instance (method).
• run (generic function).
• validate-superclass (method).

Internals

• *route-classes* (special variable).
• *routes* (special variable).
• route (reader method).
• (setf route) (writer method).

---

3.1.4 froute/src/routes.lisp

Dependencies

• package.lisp (file).
• froute-class.lisp (file).

Source

froute.asd.

Parent Component

src (module).

Internals

• build-routes (function).
• clean-route (method).
• collect-inherited-routes (method).
• copy-route (function).
• find-route (function).
• insert-into-position (function).
• make-route (function).
• num-segments (method).
• push-route (method).
• route (structure).
• route-children (reader).
• (setf route-children) (writer).
• route-class (reader).
• (setf route-class) (writer).
• route-p (function).
• route-path (reader).
• (setf route-path) (writer).

---

3.1.5 froute/src/invoke-route.lisp

Dependencies

• package.lisp (file).
• routes.lisp (file).

Source

froute.asd.

Parent Component

src (module).

Public Interface

invoke-route (function).

Internals

• add-to-vars (function).
• create-route-instance (function).
• is-variable-param (function).
• is-wildcard-variable (function).
• join-segments (function).
• make-keyword (function).
• match-segments (function).
• remove-wildcard (function).
• route-matches (function).
• split-route (function).
• trim-slashes (function).
• walk-routes (function).

---

5.1.1 Ordinary functions

Function: invoke-route (path &key method) ¶

Package

froute.

Source

invoke-route.lisp.

---

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.

---

5.1.3 Standalone methods

Method: initialize-instance :after ((class froute-class) &key) ¶

After a froute-class class is defined, we need to push it into our routes list.

Source

froute-class.lisp.

Method: reinitialize-instance :after ((class froute-class) &key) ¶

Replace the old class definition with the new one, then rebuild the routes.

Source

froute-class.lisp.

Method: validate-superclass ((class froute-class) (super-class standard-class)) ¶

Package

sb-mop.

Source

froute-class.lisp.

---

5.1.4 Classes

Class: froute-class ¶

Package

froute.

Source

froute-class.lisp.

Direct superclasses

standard-class.

Direct methods

• clean-route.
• collect-inherited-routes.
• initialize-instance.
• push-route.
• reinitialize-instance.
• (setf route).
• route.
• validate-superclass.

Direct slots

Slot: route ¶

Initargs

:route

Readers

route.

Writers

(setf route).

---

5.2.1 Special variables

Special Variable: *route-classes* ¶

Package

froute.

Source

froute-class.lisp.

Special Variable: *routes* ¶

Package

froute.

Source

froute-class.lisp.

---

5.2.2 Ordinary functions

Function: add-to-vars (var path vars) ¶

Package

froute.

Source

invoke-route.lisp.

Function: build-routes () ¶

Clears our routes mapping and builds it up from scratch.

Package

froute.

Source

routes.lisp.

Function: copy-route (instance) ¶

Package

froute.

Source

routes.lisp.

Function: create-route-instance (class params) ¶

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

Package

froute.

Source

invoke-route.lisp.

Function: find-route (path list) ¶

Finds the route with the path in the given list

Package

froute.

Source

routes.lisp.

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.

Function: is-variable-param (segment) ¶

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

Package

froute.

Source

invoke-route.lisp.

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.

Function: join-segments (segments) ¶

Rejoin the segments separated by /

Package

froute.

Source

invoke-route.lisp.

Function: make-keyword (str) ¶

Package

froute.

Source

invoke-route.lisp.

Function: make-route (&key path class children) ¶

Package

froute.

Source

routes.lisp.

Function: match-segments (route path vars) ¶

Package

froute.

Source

invoke-route.lisp.

Function: remove-wildcard (segment) ¶

Removes the * from the end of the var

Package

froute.

Source

invoke-route.lisp.

Reader: route-children (instance) ¶

Writer: (setf route-children) (instance) ¶

Package

froute.

Source

routes.lisp.

Target Slot

children.

Reader: route-class (instance) ¶

Writer: (setf route-class) (instance) ¶

Package

froute.

Source

routes.lisp.

Target Slot

class.

Function: route-matches (route method request-route request-method) ¶

Package

froute.

Source

invoke-route.lisp.

Function: route-p (object) ¶

Package

froute.

Source

routes.lisp.

Reader: route-path (instance) ¶

Writer: (setf route-path) (instance) ¶

Package

froute.

Source

routes.lisp.

Target Slot

path.

Function: split-route (route) ¶

Splits the route up into its constituent parts.

Package

froute.

Source

invoke-route.lisp.

Function: trim-slashes (route) ¶

Removes leading and trailing /

Package

froute.

Source

invoke-route.lisp.

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.

---

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.

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.

Generic Function: num-segments (route) ¶

Package

froute.

Methods

Method: num-segments ((route route)) ¶

Source

routes.lisp.

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.

Generic Reader: route (object) ¶

Package

froute.

Methods

Reader Method: route ((froute-class froute-class)) ¶

automatically generated reader method

Source

froute-class.lisp.

Target Slot

route.

Generic Writer: (setf route) (object) ¶

Package

froute.

Methods

Writer Method: (setf route) ((froute-class froute-class)) ¶

automatically generated writer method

Source

froute-class.lisp.

Target Slot

route.

---

5.2.4 Structures

Structure: route ¶

Package

froute.

Source

routes.lisp.

Direct superclasses

structure-object.

Direct methods

num-segments.

Direct slots

Slot: path ¶

Readers

route-path.

Writers

(setf route-path).

Slot: class ¶

Package

common-lisp.

Readers

route-class.

Writers

(setf route-class).

Slot: children ¶

Readers

route-children.

Writers

(setf route-children).

---