The issr-core Reference Manual

Table of Contents

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

The issr-core Reference Manual

This is the issr-core Reference Manual, version 0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 15:46:04 2021 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 issr-core

Author

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

License

LLGPL

Description

Make Interactive-Server-Side-Rendered web pages with declaritive and recursive programming. This is the core functionality is reusable for all server modules.

Version

0.1

Dependencies
Source

issr-core.asd (file)

Components

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

2 Files

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


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

2.1 Lisp


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

2.1.1 issr-core.asd

Location

issr-core.asd

Systems

issr-core (system)

Packages

issr-core-asd


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

2.1.2 issr-core/package.lisp

Parent

issr-core (system)

Location

package.lisp

Packages

issr-core


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

2.1.3 issr-core/issr-core.lisp

Dependency

package.lisp (file)

Parent

issr-core (system)

Location

issr-core.lisp

Exported Definitions
Internal Definitions

descendant (function)


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

3 Packages

Packages are listed by definition order.


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

3.1 issr-core-asd

Source

issr-core.asd

Use List

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

3.2 issr-core

Source

package.lisp (file)

Use List

common-lisp

Exported Definitions
Internal Definitions

descendant (function)


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

4 Definitions

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


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

4.1 Exported definitions


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

4.1.1 Special variables

Special Variable: *first-time*

T if it is the first time a connection is being made. Do NOT set globally; only bind dynamically. This should be the same as ‘(null ‘socket’)’.

Package

issr-core

Source

issr-core.lisp (file)

Special Variable: *id*

Used to identify the socket at the first connection. Do NOT set globally; only bind dymaically.

Package

issr-core

Source

issr-core.lisp (file)

Special Variable: *socket*

The current socket being used.
Do NOT set globally; only bind dymaically.

Package

issr-core

Source

issr-core.lisp (file)

Special Variable: *ws-port*

The port to host the websocket server on.

Package

issr-core

Source

issr-core.lisp (file)


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

4.1.2 Functions

Function: clean NODE

Remove whitespace and comments from the plump dom.

Package

issr-core

Source

issr-core.lisp (file)

Function: diff-dom OLD-DOM NEW-DOM &optional INDEX INDEXES INSTRUCTIONS
Package

issr-core

Source

issr-core.lisp (file)

Function: ensure-ids NODE

Ensures that plump dom NODE and all of its subtrees have the id attribute.
If an element does not have an id attribute, ‘ensure-ids’ mutates it to have one. Returns the possibly modified NODE.

Package

issr-core

Source

issr-core.lisp (file)

Function: generate-id &optional LENGTH &key NOT-IN

Genereate a random number that has LENGTH digits and is not a member of NOT-IN. No leading zeros.

Package

issr-core

Source

issr-core.lisp (file)

Function: hash-keys HASH-TABLE
Package

issr-core

Source

issr-core.lisp (file)


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

4.2 Internal definitions


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

4.2.1 Functions

Function: descendant NODE INDEXES
Package

issr-core

Source

issr-core.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   I   L  
Index Entry  Section

F
File, Lisp, issr-core.asd: The issr-core․asd file
File, Lisp, issr-core/issr-core.lisp: The issr-core/issr-core․lisp file
File, Lisp, issr-core/package.lisp: The issr-core/package․lisp file

I
issr-core.asd: The issr-core․asd file
issr-core/issr-core.lisp: The issr-core/issr-core․lisp file
issr-core/package.lisp: The issr-core/package․lisp file

L
Lisp File, issr-core.asd: The issr-core․asd file
Lisp File, issr-core/issr-core.lisp: The issr-core/issr-core․lisp file
Lisp File, issr-core/package.lisp: The issr-core/package․lisp file

Jump to:   F   I   L  

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

A.2 Functions

Jump to:   C   D   E   F   G   H  
Index Entry  Section

C
clean: Exported functions

D
descendant: Internal functions
diff-dom: Exported functions

E
ensure-ids: Exported functions

F
Function, clean: Exported functions
Function, descendant: Internal functions
Function, diff-dom: Exported functions
Function, ensure-ids: Exported functions
Function, generate-id: Exported functions
Function, hash-keys: Exported functions

G
generate-id: Exported functions

H
hash-keys: Exported functions

Jump to:   C   D   E   F   G   H  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*first-time*: Exported special variables
*id*: Exported special variables
*socket*: Exported special variables
*ws-port*: Exported special variables

S
Special Variable, *first-time*: Exported special variables
Special Variable, *id*: Exported special variables
Special Variable, *socket*: Exported special variables
Special Variable, *ws-port*: Exported special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   I   P   S  
Index Entry  Section

I
issr-core: The issr-core system
issr-core: The issr-core package
issr-core-asd: The issr-core-asd package

P
Package, issr-core: The issr-core package
Package, issr-core-asd: The issr-core-asd package

S
System, issr-core: The issr-core system

Jump to:   I   P   S