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

The csv Reference Manual

This is the csv Reference Manual, version 0.1.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sun Dec 15 05:52:06 2024 GMT+0.

Next: Systems, Previous: The csv Reference Manual, Up: The csv Reference Manual [Contents][Index]

1 Introduction

Next: Files, Previous: Introduction, Up: The csv Reference Manual [Contents][Index]

2 Systems

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

csv

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

2.1 `csv`

Read CSV into lists natively. Convert CSV into lists dangerously.

Author

Spenser Truex spensertruex.com

License

GNU GPL, version 3

Version

0.1.0

Source

csv.asd.

Child Components

package.lisp (file).
utils.lisp (file).
csv.lisp (file).

Next: Packages, Previous: Systems, Up: The csv Reference Manual [Contents][Index]

3 Files

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

Lisp

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

Next: csv/package.lisp, Previous: Lisp, Up: Lisp [Contents][Index]

3.1.1 `csv/csv.asd`

Source: csv.asd.
Parent Component: csv (system).
ASDF Systems: csv.

Next: csv/utils.lisp, Previous: csv/csv.asd, Up: Lisp [Contents][Index]

3.1.2 `csv/package.lisp`

Source: csv.asd.
Parent Component: csv (system).
Packages: csv.

Next: csv/csv.lisp, Previous: csv/package.lisp, Up: Lisp [Contents][Index]

3.1.3 `csv/utils.lisp`

Dependency

package.lisp (file).

Source

csv.asd.

Parent Component

csv (system).

Internals

dolines (macro).
make-reader (macro).
push-on (function).
toggle (macro).
with-gensyms (macro).

Previous: csv/utils.lisp, Up: Lisp [Contents][Index]

3.1.4 `csv/csv.lisp`

Dependency

utils.lisp (file).

Source

csv.asd.

Parent Component

csv (system).

Public Interface

slurp (function).

Internals

dequote (function).
end-tokenp (function).
make-escapep (function).
my-csv (function).
openp (function).
read-to-string (function).
slurp-csv (function).
splice (function).
str->list (function).
switches (function).

Next: Definitions, Previous: Files, Up: The csv Reference Manual [Contents][Index]

4 Packages

Packages are listed by definition order.

csv

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

4.1 `csv`

Source

package.lisp.

Use List

common-lisp.

Public Interface

slurp (function).

Internals

dequote (function).
dolines (macro).
end-tokenp (function).
make-escapep (function).
make-reader (macro).
my-csv (function).
openp (function).
push-on (function).
read-to-string (function).
slurp-csv (function).
splice (function).
str->list (function).
switches (function).
toggle (macro).
with-gensyms (macro).

Next: Indexes, Previous: Packages, Up: The csv Reference Manual [Contents][Index]

5 Definitions

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

Public Interface
Internals

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

5.1 Public Interface

Ordinary functions

Previous: Public Interface, Up: Public Interface [Contents][Index]

5.1.1 Ordinary functions

Function: slurp (path) ¶

Read in a CSV file to list. Resource intensive.

Package: csv.
Source: csv.lisp.

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

5.2 Internals

Macros
Ordinary functions

Next: Ordinary functions, Previous: Internals, Up: Internals [Contents][Index]

5.2.1 Macros

Macro: dolines ((var stream) &body body) ¶

Package: csv.
Source: utils.lisp.

Macro: make-reader (name (stream-var dispatch-1 dispatch-2) &body body) ¶

Simplify the reader macro creation process in most cases.

Package: csv.
Source: utils.lisp.

Macro: toggle (place) ¶

Flipping vars.

Package: csv.
Source: utils.lisp.

Macro: with-gensyms (symbols &body body) ¶

Create gensyms for those symbols.

Package: csv.
Source: utils.lisp.

Previous: Macros, Up: Internals [Contents][Index]

5.2.2 Ordinary functions

Function: dequote (list) ¶

Package: csv.
Source: csv.lisp.

Function: end-tokenp (prev curr) ¶

Package: csv.
Source: csv.lisp.

Function: make-escapep (prev curr) ¶

Package: csv.
Source: csv.lisp.

Function: my-csv (stream g2 g3) ¶

Package: csv.
Source: csv.lisp.

Function: openp (prev curr) ¶

Package: csv.
Source: csv.lisp.

Function: push-on (elt stack) ¶

Package: csv.
Source: utils.lisp.

Function: read-to-string (stream) ¶

Package: csv.
Source: csv.lisp.

Function: slurp-csv (path) ¶

Read in a CSV file to string. Resource intensive.

Package: csv.
Source: csv.lisp.

Function: splice (str) ¶

Package: csv.
Source: csv.lisp.

Function: str->list (str) ¶

Package: csv.
Source: csv.lisp.

Function: switches (prev curr str) ¶

Package: csv.
Source: csv.lisp.

Previous: Definitions, Up: The csv Reference Manual [Contents][Index]

Appendix A Indexes

Concepts
Functions
Variables
Data types

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

A.1 Concepts

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

A.2 Functions

Jump to:	D E F M O P R S T W

	Index Entry	Section

D
	`dequote`:	Private ordinary functions
	`dolines`:	Private macros

E
	`end-tokenp`:	Private ordinary functions

F
	`Function, dequote`:	Private ordinary functions
	`Function, end-tokenp`:	Private ordinary functions
	`Function, make-escapep`:	Private ordinary functions
	`Function, my-csv`:	Private ordinary functions
	`Function, openp`:	Private ordinary functions
	`Function, push-on`:	Private ordinary functions
	`Function, read-to-string`:	Private ordinary functions
	`Function, slurp`:	Public ordinary functions
	`Function, slurp-csv`:	Private ordinary functions
	`Function, splice`:	Private ordinary functions
	`Function, str->list`:	Private ordinary functions
	`Function, switches`:	Private ordinary functions

M
	`Macro, dolines`:	Private macros
	`Macro, make-reader`:	Private macros
	`Macro, toggle`:	Private macros
	`Macro, with-gensyms`:	Private macros
	`make-escapep`:	Private ordinary functions
	`make-reader`:	Private macros
	`my-csv`:	Private ordinary functions

O
	`openp`:	Private ordinary functions

P
	`push-on`:	Private ordinary functions

R
	`read-to-string`:	Private ordinary functions

S
	`slurp`:	Public ordinary functions
	`slurp-csv`:	Private ordinary functions
	`splice`:	Private ordinary functions
	`str->list`:	Private ordinary functions
	`switches`:	Private ordinary functions

T
	`toggle`:	Private macros

W
	`with-gensyms`:	Private macros

Next: Data types, Previous: Functions, Up: Indexes [Contents][Index]

A.3 Variables

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

A.4 Data types

Jump to:	C F P S U

	Index Entry	Section

C
	`csv`:	The csv system
	`csv`:	The csv package
	`csv.asd`:	The csv/csv․asd file
	`csv.lisp`:	The csv/csv․lisp file

F
	`File, csv.asd`:	The csv/csv․asd file
	`File, csv.lisp`:	The csv/csv․lisp file
	`File, package.lisp`:	The csv/package․lisp file
	`File, utils.lisp`:	The csv/utils․lisp file

P
	`Package, csv`:	The csv package
	`package.lisp`:	The csv/package․lisp file

S
	`System, csv`:	The csv system

U
	`utils.lisp`:	The csv/utils․lisp file

The csv Reference Manual

Table of Contents

1 Introduction

2 Systems

2.1 csv

3 Files

3.1 Lisp

3.1.1 csv/csv.asd

3.1.2 csv/package.lisp

3.1.3 csv/utils.lisp

3.1.4 csv/csv.lisp

4 Packages

4.1 csv

5 Definitions

5.1 Public Interface

5.1.1 Ordinary functions

5.2 Internals

5.2.1 Macros

5.2.2 Ordinary functions

Appendix A Indexes

A.1 Concepts

A.2 Functions

A.3 Variables

A.4 Data types

2.1 `csv`

3.1.1 `csv/csv.asd`

3.1.2 `csv/package.lisp`

3.1.3 `csv/utils.lisp`

3.1.4 `csv/csv.lisp`

4.1 `csv`