The issr Reference Manual

Table of Contents

The issr Reference Manual

This is the issr Reference Manual, version 1, generated automatically by Declt version 3.0 "Montgomery Scott" on Sun May 15 05:00:53 2022 GMT+0.

1 Systems

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

1.1 issr

Author

Charles Jackson <charles.b.jackson@protonmail.com>

License

AGPLv3

Description

Make Interactive-Server-Side-Rendered web pages with declaritive and recursive programming.

Version

1

Dependencies

• cl-base64
• alexandria
• trivia
• hunchentoot
• jonathan
• plump
• portal
• bordeaux-threads
• trivial-garbage
• do-urlencode
• str
• yxorp

Source

issr.asd (file)

Components

• package.lisp (file)
• dom.lisp (file)
• instructions.lisp (file)
• diff.lisp (file)
• core.lisp (file)
• config.lisp (file)
• proxy.lisp (file)
• main.lisp (file)

2 Files

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

2.1 Lisp

2.1.1 issr.asd

Location

issr.asd

Systems

issr (system)

2.1.2 issr/package.lisp

Parent

issr (system)

Location

package.lisp

Packages

• issr-config
• issr.dom
• issr
• issr.instructions

2.1.3 issr/dom.lisp

Parent

issr (system)

Location

dom.lisp

Exported Definitions

• add-id (function)
• copy-id (function)
• ensure-ids (function)
• make-node (function)
• node (class)
• node-attribute (method)
• node-attributes (method)
• (setf node-attributes) (method)
• node-children (method)
• (setf node-children) (method)
• node-id (method)
• node-name (method)
• (setf node-name) (method)
• plump-dom-dom (function)

Internal Definitions

• *in-pre* (special variable)
• +void-tags+ (special variable)
• node-change (method)
• (setf node-change) (method)

2.1.4 issr/instructions.lisp

Parent

issr (system)

Location

instructions.lisp

Exported Definitions

• cookie (function)
• delete (function)
• error (function)
• insert (function)
• mod (function)
• reconnect (function)
• redirect (function)

Internal Definitions

placement (type)

2.1.5 issr/diff.lisp

Parent

issr (system)

Location

diff.lisp

Internal Definitions

• diff (function)
• diff-attributes (function)
• diff-children (function)
• diff-siblings (function)
• diff-strings (function)

2.1.6 issr/core.lisp

Parent

issr (system)

Location

core.lisp

Internal Definitions

• *clients* (special variable)
• *clients*-lock (special variable)
• *ids* (special variable)
• *ids*-lock (special variable)
• api-handler (function)
• client-page (function)
• client-request (function)
• define-map-accessors-with-lock (macro)
• get-client-request (function)
• get-id-client (function)
• make-request (function)
• random-alphanum (function)
• remove-client-request (function)
• remove-id-client (function)
• request (class)
• request-headers (method)
• (setf request-headers) (method)
• request-previous-page (method)
• (setf request-previous-page) (method)
• request-query-arguments (method)
• (setf request-query-arguments) (method)
• (setf request-query-arguments) (method)
• request-uri (method)
• request-url (method)
• rr (function)
• run-application-hook (function)
• set-client-request (function)
• set-id-client (function)

2.1.7 issr/config.lisp

Parent

issr (system)

Location

config.lisp

Internal Definitions

• config (function)
• config (structure)
• config-api-port (function)
• config-application-destination (function)
• config-application-hook-destination (function)
• config-http-port (function)
• config-p (function)
• config-port (function)
• config-ssl (function)
• config-websocket-port (function)
• copy-config (function)
• destination (type)
• destination-parts (function)
• port (type)
• read-config (function)
• valid-destination-p (function)

2.1.8 issr/proxy.lisp

Parent

issr (system)

Location

proxy.lisp

Internal Definitions

• add-ids-and-js-to-html (function)
• insert-js-call (function)
• make-destinator (function)

2.1.9 issr/main.lisp

Parent

issr (system)

Location

main.lisp

Internal Definitions

start (function)

3 Packages

Packages are listed by definition order.

3.1 issr-config

Source

package.lisp (file)

Use List

common-lisp

3.2 issr.dom

Source

package.lisp (file)

Use List

common-lisp

Used By List

issr

Exported Definitions

• add-id (function)
• copy-id (function)
• ensure-ids (function)
• make-node (function)
• node (class)
• node-attribute (generic function)
• node-attribute (method)
• node-attributes (generic function)
• node-attributes (method)
• (setf node-attributes) (method)
• (setf node-attributes) (generic function)
• node-children (generic function)
• node-children (method)
• (setf node-children) (method)
• (setf node-children) (generic function)
• node-id (generic function)
• node-id (method)
• node-name (generic function)
• node-name (method)
• (setf node-name) (method)
• (setf node-name) (generic function)
• plump-dom-dom (function)

Internal Definitions

• *in-pre* (special variable)
• +void-tags+ (special variable)
• node-change (generic function)
• node-change (method)
• (setf node-change) (method)
• (setf node-change) (generic function)

3.3 issr

Source

package.lisp (file)

Use List

• issr.dom
• common-lisp

Internal Definitions

• *clients* (special variable)
• *clients*-lock (special variable)
• *ids* (special variable)
• *ids*-lock (special variable)
• add-ids-and-js-to-html (function)
• api-handler (function)
• client-page (function)
• client-request (function)
• config (function)
• config (structure)
• config-api-port (function)
• config-application-destination (function)
• config-application-hook-destination (function)
• config-http-port (function)
• config-p (function)
• config-port (function)
• config-ssl (function)
• config-websocket-port (function)
• copy-config (function)
• define-map-accessors-with-lock (macro)
• destination (type)
• destination-parts (function)
• diff (function)
• diff-attributes (function)
• diff-children (function)
• diff-siblings (function)
• diff-strings (function)
• get-client-request (function)
• get-id-client (function)
• insert-js-call (function)
• make-destinator (function)
• make-request (function)
• port (type)
• random-alphanum (function)
• read-config (function)
• remove-client-request (function)
• remove-id-client (function)
• request (class)
• request-headers (generic function)
• request-headers (method)
• (setf request-headers) (method)
• (setf request-headers) (generic function)
• request-previous-page (generic function)
• request-previous-page (method)
• (setf request-previous-page) (method)
• (setf request-previous-page) (generic function)
• request-query-arguments (generic function)
• request-query-arguments (method)
• (setf request-query-arguments) (method)
• (setf request-query-arguments) (generic function)
• (setf request-query-arguments) (method)
• request-uri (generic function)
• request-uri (method)
• request-url (generic function)
• request-url (method)
• rr (function)
• run-application-hook (function)
• set-client-request (function)
• set-id-client (function)
• start (function)
• valid-destination-p (function)

3.4 issr.instructions

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions

• cookie (function)
• delete (function)
• error (function)
• insert (function)
• mod (function)
• reconnect (function)
• redirect (function)

Internal Definitions

placement (type)

4 Definitions

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

4.1 Exported definitions

4.1.1 Functions

Function: add-id ATTRIBUTES &optional ID

Package

issr.dom

Source

dom.lisp (file)

Function: cookie ()

Package

issr.instructions

Source

instructions.lisp (file)

Function: copy-id OLD NEW

Package

issr.dom

Source

dom.lisp (file)

Function: delete IDS

Package

issr.instructions

Source

instructions.lisp (file)

Function: ensure-ids NODE

Package

issr.dom

Source

dom.lisp (file)

Function: error MESSAGE

Package

issr.instructions

Source

instructions.lisp (file)

Function: insert ID POSITION HTML

Package

issr.instructions

Source

instructions.lisp (file)

Function: make-node NAME ATTRIBUTES &rest CHILDREN

Package

issr.dom

Source

dom.lisp (file)

Function: mod ID KEY-VALUES

Package

issr.instructions

Source

instructions.lisp (file)

Function: plump-dom-dom NODE

Package

issr.dom

Source

dom.lisp (file)

Function: reconnect ()

Package

issr.instructions

Source

instructions.lisp (file)

Function: redirect TARGET

Package

issr.instructions

Source

instructions.lisp (file)

4.1.2 Generic functions

Generic Function: node-attribute THIS ATTRIBUTE

Package

issr.dom

Methods

Method: node-attribute (THIS node) ATTRIBUTE

Source

dom.lisp (file)

Generic Function: node-attributes OBJECT

Generic Function: (setf node-attributes) NEW-VALUE OBJECT

Package

issr.dom

Methods

Method: node-attributes (NODE node)

automatically generated reader method

Source

dom.lisp (file)

Method: (setf node-attributes) NEW-VALUE (NODE node)

automatically generated writer method

Source

dom.lisp (file)

Generic Function: node-children OBJECT

Generic Function: (setf node-children) NEW-VALUE OBJECT

Package

issr.dom

Methods

Method: node-children (NODE node)

automatically generated reader method

Source

dom.lisp (file)

Method: (setf node-children) NEW-VALUE (NODE node)

automatically generated writer method

Source

dom.lisp (file)

Generic Function: node-id THIS

Package

issr.dom

Methods

Method: node-id (THIS node)

Source

dom.lisp (file)

Generic Function: node-name OBJECT

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

Package

issr.dom

Methods

Method: node-name (NODE node)

automatically generated reader method

Source

dom.lisp (file)

Method: (setf node-name) NEW-VALUE (NODE node)

automatically generated writer method

Source

dom.lisp (file)

4.1.3 Classes

Class: node ()

Package

issr.dom

Source

dom.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• print-object (method)
• node-id (method)
• node-attribute (method)
• node-children (method)
• node-children (method)
• node-attributes (method)
• node-attributes (method)
• node-change (method)
• node-change (method)
• node-name (method)
• node-name (method)

Direct slots

Slot: name

Initargs

:name

Readers

node-name (generic function)

Writers

(setf node-name) (generic function)

Slot: change

Readers

node-change (generic function)

Writers

(setf node-change) (generic function)

Slot: attributes

Initargs

:attributes

Readers

node-attributes (generic function)

Writers

(setf node-attributes) (generic function)

Slot: children

Initargs

:children

Readers

node-children (generic function)

Writers

(setf node-children) (generic function)

4.2 Internal definitions

4.2.1 Special variables

Special Variable: *clients*

Key: client socket; Value: request

Package

issr

Source

core.lisp (file)

Special Variable: *clients*-lock

Package

issr

Source

core.lisp (file)

Special Variable: *ids*

Key: client id; Value: client socket

Package

issr

Source

core.lisp (file)

Special Variable: *ids*-lock

Package

issr

Source

core.lisp (file)

Special Variable: *in-pre*

Package

issr.dom

Source

dom.lisp (file)

Special Variable: +void-tags+

Package

issr.dom

Source

dom.lisp (file)

4.2.2 Macros

Macro: define-map-accessors-with-lock NAME MAP LOCK

Package

issr

Source

core.lisp (file)

4.2.3 Functions

Function: add-ids-and-js-to-html BODY

Package

issr

Source

proxy.lisp (file)

Function: api-handler APP-SERVER

Package

issr

Source

core.lisp (file)

Function: client-page CLIENT

Package

issr

Source

core.lisp (file)

Function: client-request CLIENT

Package

issr

Source

core.lisp (file)

Function: config &key (PORT PORT) (API-PORT API-PORT) (APPLICATION-DESTINATION APPLICATION-DESTINATION) (APPLICATION-HOOK-DESTINATION APPLICATION-HOOK-DESTINATION) (HTTP-PORT HTTP-PORT) (WEBSOCKET-PORT WEBSOCKET-PORT) (SSL SSL)

Package

issr

Source

config.lisp (file)

Function: config-api-port INSTANCE

Package

issr

Source

config.lisp (file)

Function: config-application-destination INSTANCE

Package

issr

Source

config.lisp (file)

Function: config-application-hook-destination INSTANCE

Package

issr

Source

config.lisp (file)

Function: config-http-port INSTANCE

Package

issr

Source

config.lisp (file)

Function: config-p OBJECT

Package

issr

Source

config.lisp (file)

Function: config-port INSTANCE

Package

issr

Source

config.lisp (file)

Function: config-ssl INSTANCE

Package

issr

Source

config.lisp (file)

Function: config-websocket-port INSTANCE

Package

issr

Source

config.lisp (file)

Function: copy-config INSTANCE

Package

issr

Source

config.lisp (file)

Function: destination-parts DESTINATION

Package

issr

Source

config.lisp (file)

Function: diff OLD NEW

Package

issr

Source

diff.lisp (file)

Function: diff-attributes OLD NEW

Package

issr

Source

diff.lisp (file)

Function: diff-children PARENT-ID OLD-CHILDREN NEW-CHILDREN

Package

issr

Source

diff.lisp (file)

Function: diff-siblings OLD-CHILDREN NEW-CHILDREN &optional INSTRUCTIONS

Package

issr

Source

diff.lisp (file)

Function: diff-strings ID OLD-TEXT NEW-TEXT

Package

issr

Source

diff.lisp (file)

Function: get-client-request KEY

Package

issr

Source

core.lisp (file)

Function: get-id-client KEY

Package

issr

Source

core.lisp (file)

Function: insert-js-call NODE ID

Package

issr

Source

proxy.lisp (file)

Function: make-destinator CONFIG

Package

issr

Source

proxy.lisp (file)

Function: make-request &key HEADERS PREVIOUS-PAGE

Package

issr

Source

core.lisp (file)

Function: random-alphanum &key LENGTH NOT-IN

Return alphanumeric string of length LENGTH not contained in NOT-IN.

Package

issr

Source

core.lisp (file)

Function: read-config FILE

Package

issr

Source

config.lisp (file)

Function: remove-client-request KEY

Package

issr

Source

core.lisp (file)

Function: remove-id-client KEY

Package

issr

Source

core.lisp (file)

Function: rr CLIENT HOST PORT MESSAGE

Package

issr

Source

core.lisp (file)

Function: run-application-hook ID HOOK HOST PORT

Package

issr

Source

core.lisp (file)

Function: set-client-request KEY VALUE

Package

issr

Source

core.lisp (file)

Function: set-id-client KEY VALUE

Package

issr

Source

core.lisp (file)

Function: start CONFIG &aux CONFIG

Package

issr

Source

main.lisp (file)

Function: valid-destination-p DESTINATION

Package

issr

Source

config.lisp (file)

4.2.4 Generic functions

Generic Function: node-change OBJECT

Generic Function: (setf node-change) NEW-VALUE OBJECT

Package

issr.dom

Methods

Method: node-change (NODE node)

automatically generated reader method

Source

dom.lisp (file)

Method: (setf node-change) NEW-VALUE (NODE node)

automatically generated writer method

Source

dom.lisp (file)

Generic Function: request-headers OBJECT

Generic Function: (setf request-headers) NEW-VALUE OBJECT

Package

issr

Methods

Method: request-headers (REQUEST request)

automatically generated reader method

Source

core.lisp (file)

Method: (setf request-headers) NEW-VALUE (REQUEST request)

automatically generated writer method

Source

core.lisp (file)

Generic Function: request-previous-page OBJECT

Generic Function: (setf request-previous-page) NEW-VALUE OBJECT

Package

issr

Methods

Method: request-previous-page (REQUEST request)

automatically generated reader method

Source

core.lisp (file)

Method: (setf request-previous-page) NEW-VALUE (REQUEST request)

automatically generated writer method

Source

core.lisp (file)

Generic Function: request-query-arguments OBJECT

Generic Function: (setf request-query-arguments) NEW-VALUE OBJECT

Package

issr

Methods

Method: request-query-arguments (REQUEST request)

automatically generated reader method

Source

core.lisp (file)

Method: (setf request-query-arguments) NEW-VALUE (REQUEST request)

automatically generated writer method

Source

core.lisp (file)

Method: (setf request-query-arguments) (THIS request) NEW-QUERY-ARGUMENTS

Source

core.lisp (file)

Generic Function: request-uri THIS

Package

issr

Methods

Method: request-uri (THIS request)

Source

core.lisp (file)

Generic Function: request-url THIS

Package

issr

Methods

Method: request-url (THIS request)

Source

core.lisp (file)

4.2.5 Structures

Structure: config ()

Package

issr

Source

config.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots

Slot: port

Type

issr::port

Initform

3000

Readers

config-port (function)

Writers

(setf config-port) (function)

Slot: api-port

Type

(or issr::port null)

Readers

config-api-port (function)

Writers

(setf config-api-port) (function)

Slot: application-destination

Type

issr::destination

Initform

8080

Readers

config-application-destination (function)

Writers

(setf config-application-destination) (function)

Slot: application-hook-destination

Type

(or issr::destination null)

Readers

config-application-hook-destination (function)

Writers

(setf config-application-hook-destination) (function)

Slot: http-port

Type

issr::port

Initform

10000

Readers

config-http-port (function)

Writers

(setf config-http-port) (function)

Slot: websocket-port

Type

issr::port

Initform

10001

Readers

config-websocket-port (function)

Writers

(setf config-websocket-port) (function)

Slot: ssl

Type

(or yxorp:ssl-config null)

Readers

config-ssl (function)

Writers

(setf config-ssl) (function)

4.2.6 Classes

Class: request ()

Package

issr

Source

core.lisp (file)

Direct superclasses

standard-object (class)

Direct methods

• (setf request-query-arguments) (method)
• request-url (method)
• request-uri (method)
• initialize-instance (method)
• request-query-arguments (method)
• request-query-arguments (method)
• request-headers (method)
• request-headers (method)
• request-previous-page (method)
• request-previous-page (method)

Direct slots

Slot: previous-page

Initargs

:previous-page

Readers

request-previous-page (generic function)

Writers

(setf request-previous-page) (generic function)

Slot: headers

Initargs

:headers

Readers

request-headers (generic function)

Writers

(setf request-headers) (generic function)

Slot: query-arguments

Readers

request-query-arguments (generic function)

Writers

(setf request-query-arguments) (generic function)

4.2.7 Types

Type: destination ()

Package

issr

Source

config.lisp (file)

Type: placement ()

Package

issr.instructions

Source

instructions.lisp (file)

Type: port ()

Package

issr

Source

config.lisp (file)

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types