The literate-lisp Reference Manual

Table of Contents

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

The literate-lisp Reference Manual

This is the literate-lisp Reference Manual, version 0.3, generated automatically by Declt version 3.0 "Montgomery Scott" on Mon Apr 19 16:55:47 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 literate-lisp

Author

Xu Jingtao <jingtaozf@gmail.com>

License

MIT

Description

a literate programming tool to write common lisp codes in org file.

Version

0.3

Source

literate-lisp.asd (file)

Component

basics (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 literate-lisp/basics

Parent

literate-lisp (system)

Location

Component

literate-lisp.lisp (file)


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 literate-lisp.asd

Location

literate-lisp.asd

Systems

literate-lisp (system)

Packages

literate-lisp.system


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

3.1.2 literate-lisp/basics/literate-lisp.lisp

Parent

basics (module)

Location

literate-lisp.lisp

Packages

literate-lisp

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 literate-lisp.system

Source

literate-lisp.asd

Use List

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

4.2 literate-lisp

a literate programming tool to write Common Lisp codes in org file.

Source

literate-lisp.lisp (file)

Nickname

lp

Use List

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 Macros

Macro: with-literate-syntax &body BODY
Package

literate-lisp

Source

literate-lisp.lisp (file)


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

5.1.2 Functions

Function: install-globally ()
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: tangle-org-file ORG-FILE &key KEEP-TEST-CODES OUTPUT-FILE
Package

literate-lisp

Source

literate-lisp.lisp (file)


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

5.2 Internal definitions


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

5.2.1 Special variables

Special Variable: debug-literate-lisp-p
Package

literate-lisp

Source

literate-lisp.lisp (file)

Special Variable: org-block-begin-id
Package

literate-lisp

Source

literate-lisp.lisp (file)

Special Variable: org-block-begin-id-length
Package

literate-lisp

Source

literate-lisp.lisp (file)

Special Variable: org-lisp-begin-src-id
Package

literate-lisp

Source

literate-lisp.lisp (file)

Special Variable: org-name-property
Package

literate-lisp

Source

literate-lisp.lisp (file)

Special Variable: org-name-property-length
Package

literate-lisp

Source

literate-lisp.lisp (file)


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

5.2.2 Functions

Function: featurep X
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: handle-feature-end-src STREAM SUB-CHAR NUMARG
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: load-p FEATURE
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: read-block-context-to-stream INPUT-STREAM BLOCK-STREAM BLOCK-NAME END-BLOCK-ID
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: read-feature-as-a-keyword STREAM
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: read-featurep-object STREAM
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: read-org-code-block-header-arguments STRING BEGIN-POSITION-OF-HEADER-ARGUMENTS
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: read-unavailable-feature-object STREAM
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: sharp-plus STREAM SUB-CHAR NUMARG
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: sharp-space STREAM A B
Package

literate-lisp

Source

literate-lisp.lisp (file)

Function: start-position-after-space-characters LINE
Package

literate-lisp

Source

literate-lisp.lisp (file)


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, literate-lisp.asd: The literate-lisp․asd file
File, Lisp, literate-lisp/basics/literate-lisp.lisp: The literate-lisp/basics/literate-lisp․lisp file

L
Lisp File, literate-lisp.asd: The literate-lisp․asd file
Lisp File, literate-lisp/basics/literate-lisp.lisp: The literate-lisp/basics/literate-lisp․lisp file
literate-lisp.asd: The literate-lisp․asd file
literate-lisp/basics: The literate-lisp/basics module
literate-lisp/basics/literate-lisp.lisp: The literate-lisp/basics/literate-lisp․lisp file

M
Module, literate-lisp/basics: The literate-lisp/basics module

Jump to:   F   L   M  

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

A.2 Functions

Jump to:   F   H   I   L   M   R   S   T   W  
Index Entry  Section

F
featurep: Internal functions
Function, featurep: Internal functions
Function, handle-feature-end-src: Internal functions
Function, install-globally: Exported functions
Function, load-p: Internal functions
Function, read-block-context-to-stream: Internal functions
Function, read-feature-as-a-keyword: Internal functions
Function, read-featurep-object: Internal functions
Function, read-org-code-block-header-arguments: Internal functions
Function, read-unavailable-feature-object: Internal functions
Function, sharp-plus: Internal functions
Function, sharp-space: Internal functions
Function, start-position-after-space-characters: Internal functions
Function, tangle-org-file: Exported functions

H
handle-feature-end-src: Internal functions

I
install-globally: Exported functions

L
load-p: Internal functions

M
Macro, with-literate-syntax: Exported macros

R
read-block-context-to-stream: Internal functions
read-feature-as-a-keyword: Internal functions
read-featurep-object: Internal functions
read-org-code-block-header-arguments: Internal functions
read-unavailable-feature-object: Internal functions

S
sharp-plus: Internal functions
sharp-space: Internal functions
start-position-after-space-characters: Internal functions

T
tangle-org-file: Exported functions

W
with-literate-syntax: Exported macros

Jump to:   F   H   I   L   M   R   S   T   W  

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

A.3 Variables

Jump to:   D   O   S  
Index Entry  Section

D
debug-literate-lisp-p: Internal special variables

O
org-block-begin-id: Internal special variables
org-block-begin-id-length: Internal special variables
org-lisp-begin-src-id: Internal special variables
org-name-property: Internal special variables
org-name-property-length: Internal special variables

S
Special Variable, debug-literate-lisp-p: Internal special variables
Special Variable, org-block-begin-id: Internal special variables
Special Variable, org-block-begin-id-length: Internal special variables
Special Variable, org-lisp-begin-src-id: Internal special variables
Special Variable, org-name-property: Internal special variables
Special Variable, org-name-property-length: Internal special variables

Jump to:   D   O   S  

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

A.4 Data types

Jump to:   L   P   S  
Index Entry  Section

L
literate-lisp: The literate-lisp system
literate-lisp: The literate-lisp package
literate-lisp.system: The literate-lisp․system package

P
Package, literate-lisp: The literate-lisp package
Package, literate-lisp.system: The literate-lisp․system package

S
System, literate-lisp: The literate-lisp system

Jump to:   L   P   S