The clj Reference Manual

Table of Contents

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

The clj Reference Manual

This is the clj Reference Manual, version 0.0.1, generated automatically by Declt version 3.0 "Montgomery Scott" on Fri Jun 26 10:47:32 2020 GMT+0.


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

1 Introduction

clj

inaimathi leo.zovic@gmail.com

Build Status

Some conveniences from the Clojure world. Because they've got some good ideas, but dammit, I'm a Common Lisper.

License

MIT Expat, the way Clojure can't be


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

2 Systems

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


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

2.1 clj

Author

Your Name <your.name@example.com>

License

Specify license here

Description

Describe clj here

Version

0.0.1

Dependencies
Source

clj.asd (file)

Component

src (module)


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

3 Modules

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


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

3.1 clj/src

Parent

clj (system)

Location

src/

Components

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

4 Files

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


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

4.1 Lisp


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

4.1.1 clj.asd

Location

clj.asd

Systems

clj (system)


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

4.1.2 clj/src/package.lisp

Parent

src (module)

Location

src/package.lisp

Packages

clj


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

4.1.3 clj/src/generics.lisp

Parent

src (module)

Location

src/generics.lisp

Exported Definitions
Internal Definitions

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

4.1.4 clj/src/types.lisp

Parent

src (module)

Location

src/types.lisp

Exported Definitions

~ (macro)

Internal Definitions

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

4.1.5 clj/src/syntax.lisp

Parent

src (module)

Location

src/syntax.lisp

Exported Definitions
Internal Definitions

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

4.1.6 clj/src/map.lisp

Parent

src (module)

Location

src/map.lisp

Exported Definitions

== (method)

Internal Definitions

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

4.1.7 clj/src/set.lisp

Parent

src (module)

Location

src/set.lisp

Exported Definitions

== (method)

Internal Definitions

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

4.1.8 clj/src/generators.lisp

Parent

src (module)

Location

src/generators.lisp


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

4.1.9 clj/src/clj.lisp

Parent

src (module)

Location

src/clj.lisp

Exported Definitions
Internal Definitions

fn (macro)


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

5 Packages

Packages are listed by definition order.


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

5.1 clj

Source

package.lisp (file)

Use List
Exported Definitions
Internal Definitions

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

6 Definitions

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


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

6.1 Exported definitions


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

6.1.1 Macros

Macro: as &rest PACKAGE/ALIAS-PAIRS

as duplicates local-package-aliases:set, but checks that the aliased packages exist before establishing them.

Package

clj

Source

clj.lisp (file)

Macro: if-let (NAME TEST) THEN &optional ELSE
Package

clj

Source

clj.lisp (file)

Macro: when-let (NAME TEST) &body THEN
Package

clj

Source

clj.lisp (file)

Macro: ~ EXP TYPE
Package

clj

Source

types.lisp (file)


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

6.1.2 Functions

Function: alist->map ALIST &key EQUALITY
Package

clj

Source

syntax.lisp (file)

Function: list->set LST
Package

clj

Source

syntax.lisp (file)


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

6.1.3 Generic functions

Generic Function: == A B
Package

clj

Source

generics.lisp (file)

Methods
Method: == (A hash-set) (B hash-set)
Source

set.lisp (file)

Method: == (A hash-dict) (B hash-dict)
Source

map.lisp (file)

Method: == (A list) (B list)
Method: == (A symbol) (B symbol)
Method: == (A character) (B character)
Method: == (A string) (B string)
Method: == (A number) (B number)
Method: == A B

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

6.2 Internal definitions


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

6.2.1 Special variables

Special Variable: *type*
Package

clj

Source

types.lisp (file)


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

6.2.2 Macros

Macro: fn &rest ARGS
Package

clj

Source

clj.lisp (file)


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

6.2.3 Functions

Function: equality-function NAME
Package

clj

Source

types.lisp (file)

Function: equality-of TYPE
Package

clj

Source

types.lisp (file)

Function: fullest-equality EQUALITIES
Package

clj

Source

types.lisp (file)

Function: kv-types K-TYPE V-TYPE
Package

clj

Source

types.lisp (file)

Function: list->map LST &key EQUALITY
Package

clj

Source

syntax.lisp (file)

Function: map-literal-reader STREAM CHAR
Package

clj

Source

syntax.lisp (file)

Function: map-type? TYPE
Package

clj

Source

types.lisp (file)

Function: map? THING
Package

clj

Source

types.lisp (file)

Function: seq-types V-TYPE
Package

clj

Source

types.lisp (file)

Function: set-literal-reader STREAM SUB-CHAR NUMARG
Package

clj

Source

syntax.lisp (file)

Function: set-type? TYPE
Package

clj

Source

types.lisp (file)

Function: set? THING
Package

clj

Source

types.lisp (file)


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

6.2.4 Generic functions

Generic Function: insert CONTAINER ELEM
Package

clj

Source

generics.lisp (file)

Methods
Method: insert (CONTAINER hash-set) ELEM
Source

set.lisp (file)

Method: insert (CONTAINER hash-dict) K/V
Source

map.lisp (file)

Method: insert (CONTAINER hash-table) K/V
Method: insert (CONTAINER list) ELEM
Generic Function: len CONTAINER
Package

clj

Source

generics.lisp (file)

Methods
Method: len (CONTAINER hash-set)
Source

set.lisp (file)

Method: len (CONTAINER hash-dict)
Source

map.lisp (file)

Method: len (CONTAINER hash-table)
Method: len (CONTAINER list)
Generic Function: lookup CONTAINER KEY
Package

clj

Source

generics.lisp (file)

Methods
Method: lookup (CONTAINER hash-set) KEY
Source

set.lisp (file)

Method: lookup (CONTAINER hash-dict) KEY
Source

map.lisp (file)

Method: lookup (CONTAINER hash-table) KEY
Method: lookup (CONTAINER list) KEY

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

6.2.5 Types

Type: map &optional KEYS VALS
Package

clj

Source

types.lisp (file)

Type: set &optional VALS
Package

clj

Source

types.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L   M  
Index Entry  Section

C
clj.asd: The clj․asd file
clj/src: The clj/src module
clj/src/clj.lisp: The clj/src/clj․lisp file
clj/src/generators.lisp: The clj/src/generators․lisp file
clj/src/generics.lisp: The clj/src/generics․lisp file
clj/src/map.lisp: The clj/src/map․lisp file
clj/src/package.lisp: The clj/src/package․lisp file
clj/src/set.lisp: The clj/src/set․lisp file
clj/src/syntax.lisp: The clj/src/syntax․lisp file
clj/src/types.lisp: The clj/src/types․lisp file

F
File, Lisp, clj.asd: The clj․asd file
File, Lisp, clj/src/clj.lisp: The clj/src/clj․lisp file
File, Lisp, clj/src/generators.lisp: The clj/src/generators․lisp file
File, Lisp, clj/src/generics.lisp: The clj/src/generics․lisp file
File, Lisp, clj/src/map.lisp: The clj/src/map․lisp file
File, Lisp, clj/src/package.lisp: The clj/src/package․lisp file
File, Lisp, clj/src/set.lisp: The clj/src/set․lisp file
File, Lisp, clj/src/syntax.lisp: The clj/src/syntax․lisp file
File, Lisp, clj/src/types.lisp: The clj/src/types․lisp file

L
Lisp File, clj.asd: The clj․asd file
Lisp File, clj/src/clj.lisp: The clj/src/clj․lisp file
Lisp File, clj/src/generators.lisp: The clj/src/generators․lisp file
Lisp File, clj/src/generics.lisp: The clj/src/generics․lisp file
Lisp File, clj/src/map.lisp: The clj/src/map․lisp file
Lisp File, clj/src/package.lisp: The clj/src/package․lisp file
Lisp File, clj/src/set.lisp: The clj/src/set․lisp file
Lisp File, clj/src/syntax.lisp: The clj/src/syntax․lisp file
Lisp File, clj/src/types.lisp: The clj/src/types․lisp file

M
Module, clj/src: The clj/src module

Jump to:   C   F   L   M  

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

A.2 Functions

Jump to:   =   ~  
A   E   F   G   I   K   L   M   S   W  
Index Entry  Section

=
==: Exported generic functions
==: Exported generic functions
==: Exported generic functions
==: Exported generic functions
==: Exported generic functions
==: Exported generic functions
==: Exported generic functions
==: Exported generic functions
==: Exported generic functions

~
~: Exported macros

A
alist->map: Exported functions
as: Exported macros

E
equality-function: Internal functions
equality-of: Internal functions

F
fn: Internal macros
fullest-equality: Internal functions
Function, alist->map: Exported functions
Function, equality-function: Internal functions
Function, equality-of: Internal functions
Function, fullest-equality: Internal functions
Function, kv-types: Internal functions
Function, list->map: Internal functions
Function, list->set: Exported functions
Function, map-literal-reader: Internal functions
Function, map-type?: Internal functions
Function, map?: Internal functions
Function, seq-types: Internal functions
Function, set-literal-reader: Internal functions
Function, set-type?: Internal functions
Function, set?: Internal functions

G
Generic Function, ==: Exported generic functions
Generic Function, insert: Internal generic functions
Generic Function, len: Internal generic functions
Generic Function, lookup: Internal generic functions

I
if-let: Exported macros
insert: Internal generic functions
insert: Internal generic functions
insert: Internal generic functions
insert: Internal generic functions
insert: Internal generic functions

K
kv-types: Internal functions

L
len: Internal generic functions
len: Internal generic functions
len: Internal generic functions
len: Internal generic functions
len: Internal generic functions
list->map: Internal functions
list->set: Exported functions
lookup: Internal generic functions
lookup: Internal generic functions
lookup: Internal generic functions
lookup: Internal generic functions
lookup: Internal generic functions

M
Macro, as: Exported macros
Macro, fn: Internal macros
Macro, if-let: Exported macros
Macro, when-let: Exported macros
Macro, ~: Exported macros
map-literal-reader: Internal functions
map-type?: Internal functions
map?: Internal functions
Method, ==: Exported generic functions
Method, ==: Exported generic functions
Method, ==: Exported generic functions
Method, ==: Exported generic functions
Method, ==: Exported generic functions
Method, ==: Exported generic functions
Method, ==: Exported generic functions
Method, ==: Exported generic functions
Method, insert: Internal generic functions
Method, insert: Internal generic functions
Method, insert: Internal generic functions
Method, insert: Internal generic functions
Method, len: Internal generic functions
Method, len: Internal generic functions
Method, len: Internal generic functions
Method, len: Internal generic functions
Method, lookup: Internal generic functions
Method, lookup: Internal generic functions
Method, lookup: Internal generic functions
Method, lookup: Internal generic functions

S
seq-types: Internal functions
set-literal-reader: Internal functions
set-type?: Internal functions
set?: Internal functions

W
when-let: Exported macros

Jump to:   =   ~  
A   E   F   G   I   K   L   M   S   W  

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

A.3 Variables

Jump to:   *  
S  
Index Entry  Section

*
*type*: Internal special variables

S
Special Variable, *type*: Internal special variables

Jump to:   *  
S  

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

A.4 Data types

Jump to:   C   M   P   S   T  
Index Entry  Section

C
clj: The clj system
clj: The clj package

M
map: Internal types

P
Package, clj: The clj package

S
set: Internal types
System, clj: The clj system

T
Type, map: Internal types
Type, set: Internal types

Jump to:   C   M   P   S   T