The myway Reference Manual

Table of Contents

The myway Reference Manual

This is the myway Reference Manual, version 0.1.0, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Dec 02 10:57:27 2019 GMT+0.

1 Introduction

My Way

My Way is a Sinatra-compatible URL routing library. This was originally written as Clack.Util.Route, a part of Clack.

Usage

(use-package :myway)

(defvar *mapper* (make-mapper))

(connect *mapper* "/" "Welcome to My Way.")

(connect *mapper* "/hello/?:name?"
         (lambda (params)
           (format nil "Hello, ~A" (or (getf params :name)
                                       "Guest"))))

(dispatch *mapper* "/")
;=> "Welcome to My Way."
;   T

(dispatch *mapper* "/hello")
;=> "Hello, Guest"
;   T

(dispatch *mapper* "/hello/Eitaro")
;=> "Hello, Eitaro"
;   T

(dispatch *mapper* "/hello/Eitaro" :method :POST)
;=> NIL
;   NIL

next-route

(connect *mapper* "/guess/:who"
         (lambda (params)
           (if (string= (getf params :who) "Eitaro")
               "You got me!"
               (next-route))))

(connect *mapper* "/guess/*"
         (lambda (params)
           (declare (ignore params))
           "You missed!"))

to-app

to-app makes a Clack app from mapper.

(to-app *mapper*)
;=> #<CLOSURE (LAMBDA (MYWAY::ENV) :IN TO-APP) {100E24F13B}>

(clack:clackup (to-app *mapper*))

Installation

(ql:quickload :myway)

Author

• Eitaro Fukamachi (e.arrows@gmail.com)

Copyright

Copyright (c) 2014 Eitaro Fukamachi (e.arrows@gmail.com)

License

Licensed under the LLGPL License.

2 Systems

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

2.1 myway

Author

Eitaro Fukamachi

License

LLGPL

Description

Sinatra-compatible routing library.

Long Description

# My Way

My Way is a Sinatra-compatible URL routing library. This was originally written as Clack.Util.Route, a part of [Clack](http://clacklisp.org/).

## Usage

“‘common-lisp
(use-package :myway)

(defvar *mapper* (make-mapper))

(connect *mapper* "/" "Welcome to My Way.")

(connect *mapper* "/hello/?:name?"
(lambda (params)
(format nil "Hello, ~A" (or (getf params :name)
"Guest"))))

(dispatch *mapper* "/")
;=> "Welcome to My Way."
; T

(dispatch *mapper* "/hello")
;=> "Hello, Guest"
; T

(dispatch *mapper* "/hello/Eitaro")
;=> "Hello, Eitaro"
; T

(dispatch *mapper* "/hello/Eitaro" :method :POST)
;=> NIL
; NIL
“‘

### next-route

“‘common-lisp
(connect *mapper* "/guess/:who"
(lambda (params)
(if (string= (getf params :who) "Eitaro")
"You got me!"
(next-route))))

(connect *mapper* "/guess/*"
(lambda (params)
(declare (ignore params))
"You missed!"))
“‘

### to-app

‘to-app‘ makes a Clack app from ‘mapper‘.

“‘common-lisp
(to-app *mapper*)
;=> #<CLOSURE (LAMBDA (MYWAY::ENV) :IN TO-APP) {100E24F13B}>

(clack:clackup (to-app *mapper*))
“‘

## Installation

“‘common-lisp
(ql:quickload :myway)
“‘

## Author

* Eitaro Fukamachi (e.arrows@gmail.com)

## Copyright

Copyright (c) 2014 Eitaro Fukamachi (e.arrows@gmail.com)

## License

Licensed under the LLGPL License.

Version

0.1.0

Dependencies

• cl-ppcre
• quri
• map-set
• alexandria
• cl-utilities

Source

myway.asd (file)

Component

src (module)

3 Modules

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

3.1 myway/src

Parent

myway (system)

Location

src/

Components

• myway.lisp (file)
• rule.lisp (file)
• route.lisp (file)
• mapper.lisp (file)
• util.lisp (file)

4 Files

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

4.1 Lisp

4.1.1 myway.asd

Location

myway.asd

Systems

myway (system)

Packages

myway-asd

4.1.2 myway/src/myway.lisp

Dependencies

• route.lisp (file)
• mapper.lisp (file)
• util.lisp (file)

Parent

src (module)

Location

src/myway.lisp

Packages

myway

Exported Definitions

• *env* (special variable)
• connect (function)
• find-route (function)
• to-app (function)

4.1.3 myway/src/rule.lisp

Parent

src (module)

Location

src/rule.lisp

Packages

myway.rule

Exported Definitions

• equal-rule (function)
• make-rule (function)
• match-rule (function)
• regex-rule (structure)
• rule (structure)
• rule-url-for (generic function)
• rule-url-for (method)
• rule-url-for (method)

Internal Definitions

• %make-regex-rule (function)
• %make-rule (function)
• *default-rule-methods* (special variable)
• compile-rule (function)
• copy-regex-rule (function)
• copy-rule (function)
• escape-special-char (function)
• list-to-map-set (function)
• match-method-p (function)
• regex-rule-format-string (function)
• (setf regex-rule-format-string) (function)
• regex-rule-methods (function)
• (setf regex-rule-methods) (function)
• regex-rule-p (function)
• regex-rule-param-keys (function)
• (setf regex-rule-param-keys) (function)
• regex-rule-regex (function)
• (setf regex-rule-regex) (function)
• regex-rule-url (function)
• (setf regex-rule-url) (function)
• rule-format-string (function)
• (setf rule-format-string) (function)
• rule-methods (function)
• (setf rule-methods) (function)
• rule-p (function)
• rule-param-keys (function)
• (setf rule-param-keys) (function)
• rule-regex (function)
• (setf rule-regex) (function)
• rule-url (function)
• (setf rule-url) (function)

4.1.4 myway/src/route.lisp

Dependency

rule.lisp (file)

Parent

src (module)

Location

src/route.lisp

Packages

myway.route

Exported Definitions

• equal-route (generic function)
• equal-route (method)
• match-route (generic function)
• match-route (method)
• route (class)
• route-handler (method)
• (setf route-handler) (method)
• route-name (method)
• (setf route-name) (method)
• route-rule (method)
• (setf route-rule) (method)
• url-for (function)

4.1.5 myway/src/mapper.lisp

Dependencies

• route.lisp (file)
• util.lisp (file)

Parent

src (module)

Location

src/mapper.lisp

Packages

myway.mapper

Exported Definitions

• add-route (function)
• clear-routes (function)
• dispatch (function)
• make-mapper (function)
• mapper (structure)
• mapper-routes (function)
• member-route (function)
• next-route (function)

Internal Definitions

• *next-route-function* (special variable)
• copy-mapper (function)
• mapper-%routes (function)
• (setf mapper-%routes) (function)
• mapper-p (function)

4.1.6 myway/src/util.lisp

Parent

src (module)

Location

src/util.lisp

Packages

myway.util

Exported Definitions

make-collector (function)

5 Packages

Packages are listed by definition order.

5.1 myway-asd

Source

myway.asd

Use List

• asdf/interface
• common-lisp

5.2 myway

Source

myway.lisp (file)

Use List

common-lisp

Exported Definitions

• *env* (special variable)
• connect (function)
• find-route (function)
• to-app (function)

5.3 myway.rule

Source

rule.lisp (file)

Use List

common-lisp

Exported Definitions

• equal-rule (function)
• make-rule (function)
• match-rule (function)
• regex-rule (structure)
• rule (structure)
• rule-url-for (generic function)
• rule-url-for (method)
• rule-url-for (method)

Internal Definitions

• %make-regex-rule (function)
• %make-rule (function)
• *default-rule-methods* (special variable)
• compile-rule (function)
• copy-regex-rule (function)
• copy-rule (function)
• escape-special-char (function)
• list-to-map-set (function)
• match-method-p (function)
• regex-rule-format-string (function)
• (setf regex-rule-format-string) (function)
• regex-rule-methods (function)
• (setf regex-rule-methods) (function)
• regex-rule-p (function)
• regex-rule-param-keys (function)
• (setf regex-rule-param-keys) (function)
• regex-rule-regex (function)
• (setf regex-rule-regex) (function)
• regex-rule-url (function)
• (setf regex-rule-url) (function)
• rule-format-string (function)
• (setf rule-format-string) (function)
• rule-methods (function)
• (setf rule-methods) (function)
• rule-p (function)
• rule-param-keys (function)
• (setf rule-param-keys) (function)
• rule-regex (function)
• (setf rule-regex) (function)
• rule-url (function)
• (setf rule-url) (function)

5.4 myway.route

Source

route.lisp (file)

Use List

common-lisp

Exported Definitions

• equal-route (generic function)
• equal-route (method)
• match-route (generic function)
• match-route (method)
• route (class)
• route-handler (generic function)
• route-handler (method)
• (setf route-handler) (method)
• (setf route-handler) (generic function)
• route-name (generic function)
• route-name (method)
• (setf route-name) (method)
• (setf route-name) (generic function)
• route-rule (generic function)
• route-rule (method)
• (setf route-rule) (method)
• (setf route-rule) (generic function)
• url-for (function)

5.5 myway.mapper

Source

mapper.lisp (file)

Use List

common-lisp

Exported Definitions

• add-route (function)
• clear-routes (function)
• dispatch (function)
• make-mapper (function)
• mapper (structure)
• mapper-routes (function)
• member-route (function)
• next-route (function)

Internal Definitions

• *next-route-function* (special variable)
• copy-mapper (function)
• mapper-%routes (function)
• (setf mapper-%routes) (function)
• mapper-p (function)

5.6 myway.util

Source

util.lisp (file)

Use List

common-lisp

Exported Definitions

make-collector (function)

6 Definitions

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

6.1 Exported definitions

6.1.1 Special variables

Special Variable: *env*

Package

myway

Source

myway.lisp (file)

6.1.2 Functions

Function: add-route MAPPER ROUTE

Package

myway.mapper

Source

mapper.lisp (file)

Function: clear-routes MAPPER

Package

myway.mapper

Source

mapper.lisp (file)

Function: connect MAPPER URL FN &key METHOD REGEXP NAME

Package

myway

Source

myway.lisp (file)

Function: dispatch MAPPER URL-STRING &key METHOD ALLOW-HEAD

Package

myway.mapper

Source

mapper.lisp (file)

Function: equal-rule RULE1 RULE2

Package

myway.rule

Source

rule.lisp (file)

Function: find-route MAPPER URL &rest ARGS &key METHOD REGEXP NAME ROUTE-CLASS &allow-other-keys

Package

myway

Source

myway.lisp (file)

Function: make-collector ()

Package

myway.util

Source

util.lisp (file)

Function: make-mapper &key (%ROUTES %ROUTES)

Package

myway.mapper

Source

mapper.lisp (file)

Function: make-rule URL &key METHOD REGEXP

Package

myway.rule

Source

rule.lisp (file)

Function: mapper-routes MAPPER

Package

myway.mapper

Source

mapper.lisp (file)

Function: match-rule RULE METHOD URL-STRING &key ALLOW-HEAD

Package

myway.rule

Source

rule.lisp (file)

Function: member-route MAPPER ROUTE

Package

myway.mapper

Source

mapper.lisp (file)

Function: next-route ()

Package

myway.mapper

Source

mapper.lisp (file)

Function: to-app MAPPER

Package

myway

Source

myway.lisp (file)

Function: url-for ROUTE PARAMS

Package

myway.route

Source

route.lisp (file)

6.1.3 Generic functions

Generic Function: equal-route ROUTE1 ROUTE2

Package

myway.route

Source

route.lisp (file)

Methods

Method: equal-route (ROUTE1 route) (ROUTE2 route)

Generic Function: match-route ROUTE METHOD URL-STRING &key ALLOW-HEAD

Package

myway.route

Source

route.lisp (file)

Methods

Method: match-route (ROUTE route) METHOD URL-STRING &key ALLOW-HEAD

Generic Function: route-handler OBJECT

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

Package

myway.route

Methods

Method: route-handler (ROUTE route)

automatically generated reader method

Source

route.lisp (file)

Method: (setf route-handler) NEW-VALUE (ROUTE route)

automatically generated writer method

Source

route.lisp (file)

Generic Function: route-name OBJECT

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

Package

myway.route

Methods

Method: route-name (ROUTE route)

automatically generated reader method

Source

route.lisp (file)

Method: (setf route-name) NEW-VALUE (ROUTE route)

automatically generated writer method

Source

route.lisp (file)

Generic Function: route-rule OBJECT

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

Package

myway.route

Methods

Method: route-rule (ROUTE route)

automatically generated reader method

Source

route.lisp (file)

Method: (setf route-rule) NEW-VALUE (ROUTE route)

automatically generated writer method

Source

route.lisp (file)

Generic Function: rule-url-for RULE PARAMS

Package

myway.rule

Source

rule.lisp (file)

Methods

Method: rule-url-for (RULE rule) PARAMS

Method: rule-url-for (RULE regex-rule) PARAMS

6.1.4 Structures

Structure: mapper ()

Package

myway.mapper

Source

mapper.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: %routes

Initform

(myway.util:make-collector)

Readers

mapper-%routes (function)

Writers

(setf mapper-%routes) (function)

Structure: regex-rule ()

Package

myway.rule

Source

rule.lisp (file)

Direct superclasses

rule (structure)

Direct methods

rule-url-for (method)

Structure: rule ()

Package

myway.rule

Source

rule.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

regex-rule (structure)

Direct methods

rule-url-for (method)

Direct slots

Slot: methods

Type

map-set:map-set

Initform

myway.rule::*default-rule-methods*

Readers

rule-methods (function)

Writers

(setf rule-methods) (function)

Slot: url

Readers

rule-url (function)

Writers

(setf rule-url) (function)

Slot: regex

Readers

rule-regex (function)

Writers

(setf rule-regex) (function)

Slot: format-string

Readers

rule-format-string (function)

Writers

(setf rule-format-string) (function)

Slot: param-keys

Readers

rule-param-keys (function)

Writers

(setf rule-param-keys) (function)

6.1.5 Classes

Class: route ()

Package

myway.route

Source

route.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• match-route (method)
• equal-route (method)
• initialize-instance (method)
• route-handler (method)
• route-handler (method)
• route-rule (method)
• route-rule (method)
• route-name (method)
• route-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

route-name (generic function)

Writers

(setf route-name) (generic function)

Slot: rule

Readers

route-rule (generic function)

Writers

(setf route-rule) (generic function)

Slot: handler

Initargs

:handler

Readers

route-handler (generic function)

Writers

(setf route-handler) (generic function)

6.2 Internal definitions

6.2.1 Special variables

Special Variable: *default-rule-methods*

Package

myway.rule

Source

rule.lisp (file)

Special Variable: *next-route-function*

Package

myway.mapper

Source

mapper.lisp (file)

6.2.2 Functions

Function: %make-regex-rule &key (METHODS METHODS) (URL URL) (REGEX REGEX) (FORMAT-STRING FORMAT-STRING) (PARAM-KEYS PARAM-KEYS)

Package

myway.rule

Source

rule.lisp (file)

Function: %make-rule &key (METHODS METHODS) (URL URL) (REGEX REGEX) (FORMAT-STRING FORMAT-STRING) (PARAM-KEYS PARAM-KEYS)

Package

myway.rule

Source

rule.lisp (file)

Function: compile-rule RULE

Package

myway.rule

Source

rule.lisp (file)

Function: copy-mapper INSTANCE

Package

myway.mapper

Source

mapper.lisp (file)

Function: copy-regex-rule INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: copy-rule INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: escape-special-char CHAR

Package

myway.rule

Source

rule.lisp (file)

Function: list-to-map-set ELEMENTS

Package

myway.rule

Source

rule.lisp (file)

Function: mapper-%routes INSTANCE

Function: (setf mapper-%routes) VALUE INSTANCE

Package

myway.mapper

Source

mapper.lisp (file)

Function: mapper-p OBJECT

Package

myway.mapper

Source

mapper.lisp (file)

Function: match-method-p RULE METHOD &key ALLOW-HEAD

Package

myway.rule

Source

rule.lisp (file)

Function: regex-rule-format-string INSTANCE

Function: (setf regex-rule-format-string) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: regex-rule-methods INSTANCE

Function: (setf regex-rule-methods) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: regex-rule-p OBJECT

Package

myway.rule

Source

rule.lisp (file)

Function: regex-rule-param-keys INSTANCE

Function: (setf regex-rule-param-keys) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: regex-rule-regex INSTANCE

Function: (setf regex-rule-regex) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: regex-rule-url INSTANCE

Function: (setf regex-rule-url) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: rule-format-string INSTANCE

Function: (setf rule-format-string) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: rule-methods INSTANCE

Function: (setf rule-methods) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: rule-p OBJECT

Package

myway.rule

Source

rule.lisp (file)

Function: rule-param-keys INSTANCE

Function: (setf rule-param-keys) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: rule-regex INSTANCE

Function: (setf rule-regex) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Function: rule-url INSTANCE

Function: (setf rule-url) VALUE INSTANCE

Package

myway.rule

Source

rule.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types