The read-csv Reference Manual

This is the read-csv Reference Manual, version 1.0.2, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:44:45 2024 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 read-csv

A library for reading CSV data from streams.

Author

Warren Wilkinson <>

License

cc0 (public domain)

Version

1.0.2

Source

read-csv.asd.

Child Component

read-csv.lisp (file).


3 Files

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


3.1 Lisp


3.1.1 read-csv/read-csv.asd

Source

read-csv.asd.

Parent Component

read-csv (system).

ASDF Systems

read-csv.


3.1.2 read-csv/read-csv.lisp

Source

read-csv.asd.

Parent Component

read-csv (system).

Packages

read-csv.

Public Interface
Internals

4 Packages

Packages are listed by definition order.


4.1 read-csv

A simple CSV file reader.

Source

read-csv.lisp.

Use List

common-lisp.

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 Ordinary functions

Function: parse-csv (stream &optional sep)

Read CSV data from a stream until end-of-file is encountered.

Package

read-csv.

Source

read-csv.lisp.

Function: read-csv (stream &optional sep eof-error-p eof-value)

Read a single line of CSV data from stream. Return the parsed CSV data and a boolean that is true when you’ve just read the last record in the stream.

eof-error-p controls how this function behaves if the first character read is end-of-file. If true, an error is thrown, if false, the eof-value is returned.

Package

read-csv.

Source

read-csv.lisp.


5.2 Internals


5.2.1 Constants

Constant: +csv-table+
Package

read-csv.

Source

read-csv.lisp.

Constant: done!
Package

read-csv.

Source

read-csv.lisp.

Constant: myquo
Package

read-csv.

Source

read-csv.lisp.

Constant: q+q&w
Package

read-csv.

Source

read-csv.lisp.

Constant: q+quo
Package

read-csv.

Source

read-csv.lisp.

Constant: q+ret
Package

read-csv.

Source

read-csv.lisp.

Constant: retur
Package

read-csv.

Source

read-csv.lisp.

Constant: start
Package

read-csv.

Source

read-csv.lisp.

Constant: unquo
Package

read-csv.

Source

read-csv.lisp.


5.2.2 Special variables

Special Variable: *record*
Package

read-csv.

Source

read-csv.lisp.

Special Variable: *records*
Package

read-csv.

Source

read-csv.lisp.

Special Variable: *white-char-count*
Package

read-csv.

Source

read-csv.lisp.


5.2.3 Ordinary functions

Function: addc (c)
Package

read-csv.

Source

read-csv.lisp.

Function: addl (c)
Package

read-csv.

Source

read-csv.lisp.

Function: char-class (sep char)
Package

read-csv.

Source

read-csv.lisp.

Function: next (c)
Package

read-csv.

Source

read-csv.lisp.

Function: noop (c)
Package

read-csv.

Source

read-csv.lisp.

Function: ship (c)
Package

read-csv.

Source

read-csv.lisp.


Appendix A Indexes


A.1 Concepts