The literate-lisp Reference Manual

This is the literate-lisp Reference Manual, version 0.6, generated automatically by Declt version 4.0 beta 2 "William Riker" on Wed May 15 06:04:03 2024 GMT+0.

Table of Contents


1 Systems

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


1.1 literate-lisp

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

Author

Xu Jingtao <>

License

MIT

Version

0.6

Dependencies
  • cl-ppcre (system).
  • iterate (system).
  • cl-fad (system).
Source

literate-lisp.asd.

Child Component

basics (module).


2 Modules

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


2.1 literate-lisp/basics

Source

literate-lisp.asd.

Parent Component

literate-lisp (system).

Child Components

3 Files

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


3.1 Lisp


3.1.1 literate-lisp/literate-lisp.asd

Source

literate-lisp.asd.

Parent Component

literate-lisp (system).

ASDF Systems

literate-lisp.

Packages

literate-lisp.system.


3.1.2 literate-lisp/basics/package.lisp

Source

literate-lisp.asd.

Parent Component

basics (module).

Packages

literate-lisp.

Internals

debug-literate-lisp-p (special variable).


3.1.3 literate-lisp/basics/parser.lisp

Dependency

package.lisp (file).

Source

literate-lisp.asd.

Parent Component

basics (module).

Internals

3.1.4 literate-lisp/basics/new-syntax.lisp

Dependency

parser.lisp (file).

Source

literate-lisp.asd.

Parent Component

basics (module).

Public Interface
Internals

3.1.5 literate-lisp/basics/tangle.lisp

Dependency

new-syntax.lisp (file).

Source

literate-lisp.asd.

Parent Component

basics (module).

Public Interface

tangle-org-file (function).

Internals

3.1.6 literate-lisp/basics/asdf.lisp

Dependency

tangle.lisp (file).

Source

literate-lisp.asd.

Parent Component

basics (module).


4 Packages

Packages are listed by definition order.


4.1 literate-lisp.system

Source

literate-lisp.asd.

Use List
  • asdf/interface.
  • common-lisp.

4.2 literate-lisp

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

Source

package.lisp.

Nickname

lp

Use List
  • cl-ppcre.
  • common-lisp.
  • iterate.
Public Interface
Internals

5 Definitions

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


5.1 Public Interface


5.1.1 Macros

Macro: with-literate-syntax (&body body)
Package

literate-lisp.

Source

new-syntax.lisp.


5.1.2 Ordinary functions

Function: install-globally ()
Package

literate-lisp.

Source

new-syntax.lisp.

Function: tangle-org-file (org-file &key features header header-args force-tangle output-name)
Package

literate-lisp.

Source

tangle.lisp.


5.2 Internals


5.2.1 Special variables

Special Variable: *check-outside-modification-p*
Package

literate-lisp.

Source

parser.lisp.

Special Variable: *current-tangle-stream*
Package

literate-lisp.

Source

parser.lisp.

Special Variable: *tangle-head-lines*
Package

literate-lisp.

Source

parser.lisp.

Special Variable: *tangle-org-file*
Package

literate-lisp.

Source

parser.lisp.

Special Variable: *tangle-streams*
Package

literate-lisp.

Source

parser.lisp.

Special Variable: current-org-context
Package

literate-lisp.

Source

parser.lisp.

Special Variable: debug-literate-lisp-p
Package

literate-lisp.

Source

package.lisp.

Special Variable: org-block-begin-id
Package

literate-lisp.

Source

new-syntax.lisp.

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

literate-lisp.

Source

new-syntax.lisp.

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

literate-lisp.

Source

new-syntax.lisp.

Special Variable: org-name-property
Package

literate-lisp.

Source

new-syntax.lisp.

Special Variable: org-name-property-length
Package

literate-lisp.

Source

new-syntax.lisp.


5.2.2 Macros

Macro: define-lexer (name regex-pattern parameters &rest body)
Package

literate-lisp.

Source

parser.lisp.

Macro: define-org-property-value-notifier (name value-name &rest body)
Package

literate-lisp.

Source

parser.lisp.


5.2.3 Setf expanders

Setf Expander: (setf org-context) (name)
Package

literate-lisp.

Source

parser.lisp.

Reader

org-context (function).

Writer

set-org-context (function).

Setf Expander: (setf org-headlines) ()
Package

literate-lisp.

Source

parser.lisp.

Reader

org-headlines (function).

Writer

set-org-headlines (function).


5.2.4 Ordinary functions

Function: cache-tangled-file (file)
Package

literate-lisp.

Source

tangle.lisp.

Function: cleanup-tangle-streams ()
Package

literate-lisp.

Source

parser.lisp.

Function: copy-headline (instance)
Package

literate-lisp.

Source

parser.lisp.

Function: current-headline ()
Package

literate-lisp.

Source

parser.lisp.

Function: current-headline-content ()
Package

literate-lisp.

Source

parser.lisp.

Function: current-headline-level ()
Package

literate-lisp.

Source

parser.lisp.

Function: featurep (x)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: handle-feature-end-src (stream sub-char numarg)
Package

literate-lisp.

Source

new-syntax.lisp.

Reader: headline-content (instance)
Writer: (setf headline-content) (instance)
Package

literate-lisp.

Source

parser.lisp.

Target Slot

content.

Reader: headline-level (instance)
Writer: (setf headline-level) (instance)
Package

literate-lisp.

Source

parser.lisp.

Target Slot

level.

Function: headline-p (object)
Package

literate-lisp.

Source

parser.lisp.

Reader: headline-properties (instance)
Writer: (setf headline-properties) (instance)
Package

literate-lisp.

Source

parser.lisp.

Target Slot

properties.

Function: load-p (feature)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: make-headline (&key level content properties)
Package

literate-lisp.

Source

parser.lisp.

Function: notify-property-value (name &optional new-value)
Package

literate-lisp.

Source

parser.lisp.

Function: org-context (name)
Package

literate-lisp.

Source

parser.lisp.

Setf expander for this function

(setf org-context).

Function: org-headlines ()
Package

literate-lisp.

Source

parser.lisp.

Setf expander for this function

(setf org-headlines).

Function: org-lexer-for-begin-of-properties (line)
Package

literate-lisp.

Source

parser.lisp.

Function: org-lexer-for-end-of-properties (line)
Package

literate-lisp.

Source

parser.lisp.

Function: org-lexer-for-headline (indicators content)
Package

literate-lisp.

Source

parser.lisp.

Function: org-lexer-for-property-in-a-line (key value)
Package

literate-lisp.

Source

parser.lisp.

Function: org-lexer-for-property-in-properties (key value)
Package

literate-lisp.

Source

parser.lisp.

Function: org-property-value (key)
Package

literate-lisp.

Source

parser.lisp.

Function: org-property-value-notifier-for-literate_export_name (name)
Package

literate-lisp.

Source

parser.lisp.

Function: path-for-literate-name (name)
Package

literate-lisp.

Source

parser.lisp.

Function: pop-org-headline ()
Package

literate-lisp.

Source

parser.lisp.

Function: property-for-headline (headline key)
Package

literate-lisp.

Source

parser.lisp.

Function: push-org-headline (level content)
Package

literate-lisp.

Source

parser.lisp.

Function: read-block-context-to-stream (input-stream block-stream block-name end-block-id)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: read-feature-as-a-keyword (stream)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: read-featurep-object (stream)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: read-keywords-from-string (string &key start)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: read-unavailable-feature-object (stream)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: run-patterns (line)
Package

literate-lisp.

Source

parser.lisp.

Function: set-org-context (name new-value)
Package

literate-lisp.

Source

parser.lisp.

Setf expanders to this function

(setf org-context).

Function: set-org-headlines (new-value)
Package

literate-lisp.

Source

parser.lisp.

Setf expanders to this function

(setf org-headlines).

Function: setup-headline ()
Package

literate-lisp.

Source

parser.lisp.

Function: sharp-org (stream)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: sharp-plus (stream sub-char numarg)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: sharp-space (stream a b)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: start-position-after-space-characters (line)
Package

literate-lisp.

Source

new-syntax.lisp.

Function: tangle-p ()
Package

literate-lisp.

Source

parser.lisp.

Function: tangle-stream (name)
Package

literate-lisp.

Source

parser.lisp.

Function: tangled-cached-file (path)
Package

literate-lisp.

Source

tangle.lisp.

Function: tangled-file-update-outside-p (file)
Package

literate-lisp.

Source

tangle.lisp.

Function: update-property-value (key value)
Package

literate-lisp.

Source

parser.lisp.


5.2.5 Structures

Structure: headline
Package

literate-lisp.

Source

parser.lisp.

Direct superclasses

structure-object.

Direct slots
Slot: level
Type

integer

Initform

0

Readers

headline-level.

Writers

(setf headline-level).

Slot: content
Type

string

Initform

""

Readers

headline-content.

Writers

(setf headline-content).

Slot: properties
Type

hash-table

Initform

(make-hash-table :test (function equalp))

Readers

headline-properties.

Writers

(setf headline-properties).


Appendix A Indexes


A.1 Concepts


A.2 Functions

Jump to:   (  
C   D   F   H   I   L   M   N   O   P   R   S   T   U   W  
Index Entry  Section

(
(setf headline-content): Private ordinary functions
(setf headline-level): Private ordinary functions
(setf headline-properties): Private ordinary functions
(setf org-context): Private setf expanders
(setf org-headlines): Private setf expanders

C
cache-tangled-file: Private ordinary functions
cleanup-tangle-streams: Private ordinary functions
copy-headline: Private ordinary functions
current-headline: Private ordinary functions
current-headline-content: Private ordinary functions
current-headline-level: Private ordinary functions

D
define-lexer: Private macros
define-org-property-value-notifier: Private macros

F
featurep: Private ordinary functions
Function, (setf headline-content): Private ordinary functions
Function, (setf headline-level): Private ordinary functions
Function, (setf headline-properties): Private ordinary functions
Function, cache-tangled-file: Private ordinary functions
Function, cleanup-tangle-streams: Private ordinary functions
Function, copy-headline: Private ordinary functions
Function, current-headline: Private ordinary functions
Function, current-headline-content: Private ordinary functions
Function, current-headline-level: Private ordinary functions
Function, featurep: Private ordinary functions
Function, handle-feature-end-src: Private ordinary functions
Function, headline-content: Private ordinary functions
Function, headline-level: Private ordinary functions
Function, headline-p: Private ordinary functions
Function, headline-properties: Private ordinary functions
Function, install-globally: Public ordinary functions
Function, load-p: Private ordinary functions
Function, make-headline: Private ordinary functions
Function, notify-property-value: Private ordinary functions
Function, org-context: Private ordinary functions
Function, org-headlines: Private ordinary functions
Function, org-lexer-for-begin-of-properties: Private ordinary functions
Function, org-lexer-for-end-of-properties: Private ordinary functions
Function, org-lexer-for-headline: Private ordinary functions
Function, org-lexer-for-property-in-a-line: Private ordinary functions
Function, org-lexer-for-property-in-properties: Private ordinary functions
Function, org-property-value: Private ordinary functions
Function, org-property-value-notifier-for-literate_export_name: Private ordinary functions
Function, path-for-literate-name: Private ordinary functions
Function, pop-org-headline: Private ordinary functions
Function, property-for-headline: Private ordinary functions
Function, push-org-headline: Private ordinary functions
Function, read-block-context-to-stream: Private ordinary functions
Function, read-feature-as-a-keyword: Private ordinary functions
Function, read-featurep-object: Private ordinary functions
Function, read-keywords-from-string: Private ordinary functions
Function, read-unavailable-feature-object: Private ordinary functions
Function, run-patterns: Private ordinary functions
Function, set-org-context: Private ordinary functions
Function, set-org-headlines: Private ordinary functions
Function, setup-headline: Private ordinary functions
Function, sharp-org: Private ordinary functions
Function, sharp-plus: Private ordinary functions
Function, sharp-space: Private ordinary functions
Function, start-position-after-space-characters: Private ordinary functions
Function, tangle-org-file: Public ordinary functions
Function, tangle-p: Private ordinary functions
Function, tangle-stream: Private ordinary functions
Function, tangled-cached-file: Private ordinary functions
Function, tangled-file-update-outside-p: Private ordinary functions
Function, update-property-value: Private ordinary functions

H
handle-feature-end-src: Private ordinary functions
headline-content: Private ordinary functions
headline-level: Private ordinary functions
headline-p: Private ordinary functions
headline-properties: Private ordinary functions

I
install-globally: Public ordinary functions

L
load-p: Private ordinary functions

M
Macro, define-lexer: Private macros
Macro, define-org-property-value-notifier: Private macros
Macro, with-literate-syntax: Public macros
make-headline: Private ordinary functions

N
notify-property-value: Private ordinary functions

O
org-context: Private ordinary functions
org-headlines: Private ordinary functions
org-lexer-for-begin-of-properties: Private ordinary functions
org-lexer-for-end-of-properties: Private ordinary functions
org-lexer-for-headline: Private ordinary functions
org-lexer-for-property-in-a-line: Private ordinary functions
org-lexer-for-property-in-properties: Private ordinary functions
org-property-value: Private ordinary functions
org-property-value-notifier-for-literate_export_name: Private ordinary functions

P
path-for-literate-name: Private ordinary functions
pop-org-headline: Private ordinary functions
property-for-headline: Private ordinary functions
push-org-headline: Private ordinary functions

R
read-block-context-to-stream: Private ordinary functions
read-feature-as-a-keyword: Private ordinary functions
read-featurep-object: Private ordinary functions
read-keywords-from-string: Private ordinary functions
read-unavailable-feature-object: Private ordinary functions
run-patterns: Private ordinary functions

S
set-org-context: Private ordinary functions
set-org-headlines: Private ordinary functions
Setf Expander, (setf org-context): Private setf expanders
Setf Expander, (setf org-headlines): Private setf expanders
setup-headline: Private ordinary functions
sharp-org: Private ordinary functions
sharp-plus: Private ordinary functions
sharp-space: Private ordinary functions
start-position-after-space-characters: Private ordinary functions

T
tangle-org-file: Public ordinary functions
tangle-p: Private ordinary functions
tangle-stream: Private ordinary functions
tangled-cached-file: Private ordinary functions
tangled-file-update-outside-p: Private ordinary functions

U
update-property-value: Private ordinary functions

W
with-literate-syntax: Public macros


A.3 Variables

Jump to:   *  
C   D   L   O   P   S  
Index Entry  Section

*
*check-outside-modification-p*: Private special variables
*current-tangle-stream*: Private special variables
*tangle-head-lines*: Private special variables
*tangle-org-file*: Private special variables
*tangle-streams*: Private special variables

C
content: Private structures
current-org-context: Private special variables

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

L
level: Private structures

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

P
properties: Private structures

S
Slot, content: Private structures
Slot, level: Private structures
Slot, properties: Private structures
Special Variable, *check-outside-modification-p*: Private special variables
Special Variable, *current-tangle-stream*: Private special variables
Special Variable, *tangle-head-lines*: Private special variables
Special Variable, *tangle-org-file*: Private special variables
Special Variable, *tangle-streams*: Private special variables
Special Variable, current-org-context: Private special variables
Special Variable, debug-literate-lisp-p: Private special variables
Special Variable, org-block-begin-id: Private special variables
Special Variable, org-block-begin-id-length: Private special variables
Special Variable, org-lisp-begin-src-id: Private special variables
Special Variable, org-name-property: Private special variables
Special Variable, org-name-property-length: Private special variables