The cl-table Reference Manual

Table of Contents

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

The cl-table Reference Manual

This is the cl-table Reference Manual, version 0.9, generated automatically by Declt version 2.3 "Robert April" on Tue Feb 20 08:19:46 2018 GMT+0.


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

1 Introduction

cl-table

GtkTreeStore-like tables with sorting, selecting and rows hierarchy


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 cl-table

Author

Roman Klochkov <kalimehtar@mail.ru>

License

BSD

Description

Hierarchical tables in Lisp

Version

0.9

Dependency

iterate

Source

cl-table.asd (file)

Components

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 cl-table.asd

Location

cl-table.asd

Systems

cl-table (system)

Packages

cl-table-system


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

3.1.2 cl-table/package.lisp

Parent

cl-table (system)

Location

package.lisp

Packages

cl-table


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

3.1.3 cl-table/table.lisp

Dependency

package.lisp (file)

Parent

cl-table (system)

Location

table.lisp

Exported Definitions
Internal Definitions

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

3.1.4 cl-table/iterator.lisp

Dependency

table.lisp (file)

Parent

cl-table (system)

Location

iterator.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 cl-table-system

Source

cl-table.asd

Use List

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

4.2 cl-table

Source

package.lisp (file)

Use List
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 Functions

Function: drop-columns! TABLE COLUMNS
Package

cl-table

Source

table.lisp (file)

Function: field STR KEY

Returns field of row STR with name symbol KEY

Package

cl-table

Source

table.lisp (file)

Setf Expander

(setf field) (setf expander)

Setf Expander: (setf field) STR KEY
Package

cl-table

Source

table.lisp (file)

Reader

field (function)

Function: make-iterator TABLE

Returns array of iter-row

Package

cl-table

Source

iterator.lisp (file)


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

5.1.2 Generic functions

Generic Function: add TO-PLACE
Package

cl-table

Source

table.lisp (file)

Methods
Method: add (ROW row)
Method: add (TABLE table)
Generic Function: columns OBJECT
Generic Function: (setf columns) NEW-VALUE OBJECT
Package

cl-table

Methods
Method: columns (TABLE table)

automatically generated reader method

Source

table.lisp (file)

Method: (setf columns) NEW-VALUE (TABLE table)

automatically generated writer method

Source

table.lisp (file)

Generic Function: path->row TABLE PATH
Package

cl-table

Source

table.lisp (file)

Methods
Method: path->row (ITER-ROW iter-row) PATH
Source

iterator.lisp (file)

Method: path->row (ITER-TABLE iter-table) PATH
Source

iterator.lisp (file)

Method: path->row (TABLE table) PATH
Method: path->row TABLE (PATH fixnum) around

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

5.1.3 Classes

Class: table ()
Package

cl-table

Source

table.lisp (file)

Direct superclasses

standard-object (class)

Direct methods
  • path->row (method)
  • add (method)
  • shared-initialize (method)
  • indexes (method)
  • indexes (method)
  • rows (method)
  • rows (method)
  • columns (method)
  • columns (method)
Direct slots
Slot: columns
Type

list

Readers

columns (generic function)

Writers

(setf columns) (generic function)

Slot: rows

List of lists = data in (car row), list of children rows in (cdr row) Assert (length (car row)) == (length columns)

Type

list

Readers

rows (generic function)

Writers

(setf rows) (generic function)

Slot: indexes
Type

list

Readers

indexes (generic function)

Writers

(setf indexes) (generic function)


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

5.2 Internal definitions


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

5.2.1 Macros

Macro: append-item ITEM LIST
Package

cl-table

Source

table.lisp (file)

Macro: clause-for-in-table-1 &key (FOR VAR) (IN-TABLE TABLE)

Rows of a table: row = (table field1 field2 ...)

Package

cl-table

Source

table.lisp (file)

Macro: clause-for-in-table-row-2 &key (FOR VAR) (IN-TABLE-ROW TABLE)

Rows of a table: row = (table field1 field2 ...)

Package

cl-table

Source

table.lisp (file)


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

5.2.2 Functions

Function: aref* ARRAY INDEX
Package

cl-table

Source

iterator.lisp (file)

Function: column-name INSTANCE
Function: (setf column-name) VALUE INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: column-p OBJECT
Package

cl-table

Source

table.lisp (file)

Function: column-type INSTANCE
Function: (setf column-type) VALUE INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: compare-rows COLS PRED ROW1 ROW2
Package

cl-table

Source

table.lisp (file)

Function: copy-column INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: copy-iter-row INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: copy-iter-table INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: copy-row INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: equal-rows COLS ROW1 ROW2
Package

cl-table

Source

table.lisp (file)

Function: iter-row-children INSTANCE
Function: (setf iter-row-children) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-row-children-vector INSTANCE
Function: (setf iter-row-children-vector) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-row-data INSTANCE
Function: (setf iter-row-data) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-row-id INSTANCE
Function: (setf iter-row-id) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-row-num INSTANCE
Function: (setf iter-row-num) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-row-p OBJECT
Package

cl-table

Source

iterator.lisp (file)

Function: iter-row-parent INSTANCE
Function: (setf iter-row-parent) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-row-ref INSTANCE
Function: (setf iter-row-ref) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-row-table INSTANCE
Function: (setf iter-row-table) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-table-all INSTANCE
Function: (setf iter-table-all) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: iter-table-p OBJECT
Package

cl-table

Source

iterator.lisp (file)

Function: iter-table-top INSTANCE
Function: (setf iter-table-top) VALUE INSTANCE
Package

cl-table

Source

iterator.lisp (file)

Function: make-column &key (NAME NAME) (TYPE TYPE)
Package

cl-table

Source

table.lisp (file)

Function: make-iter-row &key (PARENT PARENT) (REF REF) (CHILDREN CHILDREN) (TABLE TABLE) (NUM NUM) (DATA DATA) (ID ID) (CHILDREN-VECTOR CHILDREN-VECTOR)
Package

cl-table

Source

iterator.lisp (file)

Function: make-iter-table &key (ALL ALL) (TOP TOP)
Package

cl-table

Source

iterator.lisp (file)

Function: make-row &key (PARENT PARENT) (REF REF) (CHILDREN CHILDREN) (TABLE TABLE) (NUM NUM) (DATA DATA)
Package

cl-table

Source

table.lisp (file)

Function: map-table FUNC TABLE
Package

cl-table

Source

table.lisp (file)

Function: map-table-row FUNC ROW
Package

cl-table

Source

table.lisp (file)

Function: row-children INSTANCE
Function: (setf row-children) VALUE INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: row-data INSTANCE
Function: (setf row-data) VALUE INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: row-num INSTANCE
Function: (setf row-num) VALUE INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: row-p OBJECT
Package

cl-table

Source

table.lisp (file)

Function: row-parent INSTANCE
Function: (setf row-parent) VALUE INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: row-ref INSTANCE
Function: (setf row-ref) VALUE INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: row-table INSTANCE
Function: (setf row-table) VALUE INSTANCE
Package

cl-table

Source

table.lisp (file)

Function: sort! TABLE COLUMNS
Package

cl-table

Source

table.lisp (file)

Function: sum-columns! SUM-COLUMNS DST-ROW SRC-ROW

For each column in list SUM-COLUMNS put sum of fields from dst and src rows to dst-row

Package

cl-table

Source

table.lisp (file)

Function: wrap! TABLE GROUP-COLUMNS SUM-COLUMNS
Package

cl-table

Source

table.lisp (file)


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

5.2.3 Generic functions

Generic Function: generic-lessp X Y

Order by numbers or strings

Package

cl-table

Source

table.lisp (file)

Methods
Method: generic-lessp (X string) (Y string)
Method: generic-lessp (X string) Y
Method: generic-lessp X (Y string)
Method: generic-lessp (X number) (Y number)
Generic Function: indexes OBJECT
Generic Function: (setf indexes) NEW-VALUE OBJECT
Package

cl-table

Methods
Method: indexes (TABLE table)

automatically generated reader method

Source

table.lisp (file)

Method: (setf indexes) NEW-VALUE (TABLE table)

automatically generated writer method

Source

table.lisp (file)

Generic Function: rows OBJECT
Generic Function: (setf rows) NEW-VALUE OBJECT
Package

cl-table

Methods
Method: rows (TABLE table)
Method: (setf rows) NEW-VALUE (TABLE table)

List of lists = data in (car row), list of children rows in (cdr row) Assert (length (car row)) == (length columns)

Source

table.lisp (file)


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

5.2.4 Structures

Structure: column ()
Package

cl-table

Source

table.lisp (file)

Direct superclasses

structure-object (structure)

Direct slots
Slot: name
Type

(and symbol (not null))

Readers

column-name (function)

Writers

(setf column-name) (function)

Slot: type
Type

(or symbol list)

Initform

t

Readers

column-type (function)

Writers

(setf column-type) (function)

Structure: iter-row ()

Iterator element

Package

cl-table

Source

iterator.lisp (file)

Direct superclasses

row (structure)

Direct methods

path->row (method)

Direct slots
Slot: id
Type

fixnum

Initform

0

Readers

iter-row-id (function)

Writers

(setf iter-row-id) (function)

Slot: children-vector
Type

(vector cl-table::iter-row)

Initform

#()

Readers

iter-row-children-vector (function)

Writers

(setf iter-row-children-vector) (function)

Structure: iter-table ()
Package

cl-table

Source

iterator.lisp (file)

Direct superclasses

structure-object (structure)

Direct methods

path->row (method)

Direct slots
Slot: all
Type

(vector cl-table::iter-row)

Initform

#()

Readers

iter-table-all (function)

Writers

(setf iter-table-all) (function)

Slot: top
Type

(vector cl-table::iter-row)

Initform

#()

Readers

iter-table-top (function)

Writers

(setf iter-table-top) (function)

Structure: row ()

Struct for representing row in table

Package

cl-table

Source

table.lisp (file)

Direct superclasses

structure-object (structure)

Direct subclasses

iter-row (structure)

Direct methods

add (method)

Direct slots
Slot: parent
Type

(or null cl-table::row)

Readers

row-parent (function)

Writers

(setf row-parent) (function)

Slot: ref
Type

list

Readers

row-ref (function)

Writers

(setf row-ref) (function)

Slot: children
Type

list

Readers

row-children (function)

Writers

(setf row-children) (function)

Slot: table
Type

cl-table:table

Readers

row-table (function)

Writers

(setf row-table) (function)

Slot: num
Type

fixnum

Initform

0

Readers

row-num (function)

Writers

(setf row-num) (function)

Slot: data
Type

list

Readers

row-data (function)

Writers

(setf row-data) (function)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   C   F   L  
Index Entry  Section

C
cl-table.asd: The cl-table<dot>asd file
cl-table/iterator.lisp: The cl-table/iterator<dot>lisp file
cl-table/package.lisp: The cl-table/package<dot>lisp file
cl-table/table.lisp: The cl-table/table<dot>lisp file

F
File, Lisp, cl-table.asd: The cl-table<dot>asd file
File, Lisp, cl-table/iterator.lisp: The cl-table/iterator<dot>lisp file
File, Lisp, cl-table/package.lisp: The cl-table/package<dot>lisp file
File, Lisp, cl-table/table.lisp: The cl-table/table<dot>lisp file

L
Lisp File, cl-table.asd: The cl-table<dot>asd file
Lisp File, cl-table/iterator.lisp: The cl-table/iterator<dot>lisp file
Lisp File, cl-table/package.lisp: The cl-table/package<dot>lisp file
Lisp File, cl-table/table.lisp: The cl-table/table<dot>lisp file

Jump to:   C   F   L  

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

A.2 Functions

Jump to:   (  
A   C   D   E   F   G   I   M   P   R   S   W  
Index Entry  Section

(
(setf column-name): Internal functions
(setf column-type): Internal functions
(setf columns): Exported generic functions
(setf columns): Exported generic functions
(setf field): Exported functions
(setf indexes): Internal generic functions
(setf indexes): Internal generic functions
(setf iter-row-children): Internal functions
(setf iter-row-children-vector): Internal functions
(setf iter-row-data): Internal functions
(setf iter-row-id): Internal functions
(setf iter-row-num): Internal functions
(setf iter-row-parent): Internal functions
(setf iter-row-ref): Internal functions
(setf iter-row-table): Internal functions
(setf iter-table-all): Internal functions
(setf iter-table-top): Internal functions
(setf row-children): Internal functions
(setf row-data): Internal functions
(setf row-num): Internal functions
(setf row-parent): Internal functions
(setf row-ref): Internal functions
(setf row-table): Internal functions
(setf rows): Internal generic functions
(setf rows): Internal generic functions

A
add: Exported generic functions
add: Exported generic functions
add: Exported generic functions
append-item: Internal macros
aref*: Internal functions

C
clause-for-in-table-1: Internal macros
clause-for-in-table-row-2: Internal macros
column-name: Internal functions
column-p: Internal functions
column-type: Internal functions
columns: Exported generic functions
columns: Exported generic functions
compare-rows: Internal functions
copy-column: Internal functions
copy-iter-row: Internal functions
copy-iter-table: Internal functions
copy-row: Internal functions

D
drop-columns!: Exported functions

E
equal-rows: Internal functions

F
field: Exported functions
Function, (setf column-name): Internal functions
Function, (setf column-type): Internal functions
Function, (setf iter-row-children): Internal functions
Function, (setf iter-row-children-vector): Internal functions
Function, (setf iter-row-data): Internal functions
Function, (setf iter-row-id): Internal functions
Function, (setf iter-row-num): Internal functions
Function, (setf iter-row-parent): Internal functions
Function, (setf iter-row-ref): Internal functions
Function, (setf iter-row-table): Internal functions
Function, (setf iter-table-all): Internal functions
Function, (setf iter-table-top): Internal functions
Function, (setf row-children): Internal functions
Function, (setf row-data): Internal functions
Function, (setf row-num): Internal functions
Function, (setf row-parent): Internal functions
Function, (setf row-ref): Internal functions
Function, (setf row-table): Internal functions
Function, aref*: Internal functions
Function, column-name: Internal functions
Function, column-p: Internal functions
Function, column-type: Internal functions
Function, compare-rows: Internal functions
Function, copy-column: Internal functions
Function, copy-iter-row: Internal functions
Function, copy-iter-table: Internal functions
Function, copy-row: Internal functions
Function, drop-columns!: Exported functions
Function, equal-rows: Internal functions
Function, field: Exported functions
Function, iter-row-children: Internal functions
Function, iter-row-children-vector: Internal functions
Function, iter-row-data: Internal functions
Function, iter-row-id: Internal functions
Function, iter-row-num: Internal functions
Function, iter-row-p: Internal functions
Function, iter-row-parent: Internal functions
Function, iter-row-ref: Internal functions
Function, iter-row-table: Internal functions
Function, iter-table-all: Internal functions
Function, iter-table-p: Internal functions
Function, iter-table-top: Internal functions
Function, make-column: Internal functions
Function, make-iter-row: Internal functions
Function, make-iter-table: Internal functions
Function, make-iterator: Exported functions
Function, make-row: Internal functions
Function, map-table: Internal functions
Function, map-table-row: Internal functions
Function, row-children: Internal functions
Function, row-data: Internal functions
Function, row-num: Internal functions
Function, row-p: Internal functions
Function, row-parent: Internal functions
Function, row-ref: Internal functions
Function, row-table: Internal functions
Function, sort!: Internal functions
Function, sum-columns!: Internal functions
Function, wrap!: Internal functions

G
Generic Function, (setf columns): Exported generic functions
Generic Function, (setf indexes): Internal generic functions
Generic Function, (setf rows): Internal generic functions
Generic Function, add: Exported generic functions
Generic Function, columns: Exported generic functions
Generic Function, generic-lessp: Internal generic functions
Generic Function, indexes: Internal generic functions
Generic Function, path->row: Exported generic functions
Generic Function, rows: Internal generic functions
generic-lessp: Internal generic functions
generic-lessp: Internal generic functions
generic-lessp: Internal generic functions
generic-lessp: Internal generic functions
generic-lessp: Internal generic functions

I
indexes: Internal generic functions
indexes: Internal generic functions
iter-row-children: Internal functions
iter-row-children-vector: Internal functions
iter-row-data: Internal functions
iter-row-id: Internal functions
iter-row-num: Internal functions
iter-row-p: Internal functions
iter-row-parent: Internal functions
iter-row-ref: Internal functions
iter-row-table: Internal functions
iter-table-all: Internal functions
iter-table-p: Internal functions
iter-table-top: Internal functions

M
Macro, append-item: Internal macros
Macro, clause-for-in-table-1: Internal macros
Macro, clause-for-in-table-row-2: Internal macros
make-column: Internal functions
make-iter-row: Internal functions
make-iter-table: Internal functions
make-iterator: Exported functions
make-row: Internal functions
map-table: Internal functions
map-table-row: Internal functions
Method, (setf columns): Exported generic functions
Method, (setf indexes): Internal generic functions
Method, (setf rows): Internal generic functions
Method, add: Exported generic functions
Method, add: Exported generic functions
Method, columns: Exported generic functions
Method, generic-lessp: Internal generic functions
Method, generic-lessp: Internal generic functions
Method, generic-lessp: Internal generic functions
Method, generic-lessp: Internal generic functions
Method, indexes: Internal generic functions
Method, path->row: Exported generic functions
Method, path->row: Exported generic functions
Method, path->row: Exported generic functions
Method, path->row: Exported generic functions
Method, rows: Internal generic functions

P
path->row: Exported generic functions
path->row: Exported generic functions
path->row: Exported generic functions
path->row: Exported generic functions
path->row: Exported generic functions

R
row-children: Internal functions
row-data: Internal functions
row-num: Internal functions
row-p: Internal functions
row-parent: Internal functions
row-ref: Internal functions
row-table: Internal functions
rows: Internal generic functions
rows: Internal generic functions

S
Setf Expander, (setf field): Exported functions
sort!: Internal functions
sum-columns!: Internal functions

W
wrap!: Internal functions

Jump to:   (  
A   C   D   E   F   G   I   M   P   R   S   W  

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

A.3 Variables

Jump to:   A   C   D   I   N   P   R   S   T  
Index Entry  Section

A
all: Internal structures

C
children: Internal structures
children-vector: Internal structures
columns: Exported classes

D
data: Internal structures

I
id: Internal structures
indexes: Exported classes

N
name: Internal structures
num: Internal structures

P
parent: Internal structures

R
ref: Internal structures
rows: Exported classes

S
Slot, all: Internal structures
Slot, children: Internal structures
Slot, children-vector: Internal structures
Slot, columns: Exported classes
Slot, data: Internal structures
Slot, id: Internal structures
Slot, indexes: Exported classes
Slot, name: Internal structures
Slot, num: Internal structures
Slot, parent: Internal structures
Slot, ref: Internal structures
Slot, rows: Exported classes
Slot, table: Internal structures
Slot, top: Internal structures
Slot, type: Internal structures

T
table: Internal structures
top: Internal structures
type: Internal structures

Jump to:   A   C   D   I   N   P   R   S   T  

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

A.4 Data types

Jump to:   C   I   P   R   S   T  
Index Entry  Section

C
cl-table: The cl-table system
cl-table: The cl-table package
cl-table-system: The cl-table-system package
Class, table: Exported classes
column: Internal structures

I
iter-row: Internal structures
iter-table: Internal structures

P
Package, cl-table: The cl-table package
Package, cl-table-system: The cl-table-system package

R
row: Internal structures

S
Structure, column: Internal structures
Structure, iter-row: Internal structures
Structure, iter-table: Internal structures
Structure, row: Internal structures
System, cl-table: The cl-table system

T
table: Exported classes

Jump to:   C   I   P   R   S   T