The read-csv Reference Manual

Table of Contents

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

The read-csv Reference Manual

This is the read-csv Reference Manual, version 1.0.2, generated automatically by Declt version 2.3 "Robert April" on Wed Mar 14 04:31:16 2018 GMT+0.


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

1 Introduction

read-csv

read-csv is a stream oriented CSV (comma-separated value) reader.

(ql:quickload 'read-csv)
(use-package :read-csv)
(with-open-file (s "/path/to/csv")
  (parse-csv s))
;; Returns a list of lists of strings.

Tests

Once the system is loaded, it can be tested with asdf.

(asdf:operate 'asdf:test-op :read-csv)
RUNNING READ-CSV TESTS...
READ-CSV TEST RESULTS:
   Tests: 519
 Success: 519
Failures: 0

License

Read-csv is public domain.


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 read-csv

Author

Warren Wilkinson <warrenwilkinson@gmail.com>

License

cc0 (public domain)

Description

A library for reading CSV data from streams.

Version

1.0.2

Source

read-csv.asd (file)

Component

read-csv.lisp (file)


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 read-csv.asd

Location

read-csv.asd

Systems

read-csv (system)


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

3.1.2 read-csv/read-csv.lisp

Parent

read-csv (system)

Location

read-csv.lisp

Packages

read-csv

Exported Definitions
Internal Definitions

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

4 Packages

Packages are listed by definition order.


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

4.1 read-csv

A simple CSV file reader.

Source

read-csv.lisp (file)

Use List

common-lisp

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


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

5.1.1 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 (file)

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 (file)


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

5.2 Internal definitions


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

5.2.1 Constants

Constant: +csv-table+
Package

read-csv

Source

read-csv.lisp (file)

Constant: done!
Package

read-csv

Source

read-csv.lisp (file)

Constant: myquo
Package

read-csv

Source

read-csv.lisp (file)

Constant: q+q&w
Package

read-csv

Source

read-csv.lisp (file)

Constant: q+quo
Package

read-csv

Source

read-csv.lisp (file)

Constant: q+ret
Package

read-csv

Source

read-csv.lisp (file)

Constant: retur
Package

read-csv

Source

read-csv.lisp (file)

Constant: start
Package

read-csv

Source

read-csv.lisp (file)

Constant: unquo
Package

read-csv

Source

read-csv.lisp (file)


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

5.2.2 Special variables

Special Variable: *record*
Package

read-csv

Source

read-csv.lisp (file)

Special Variable: *records*
Package

read-csv

Source

read-csv.lisp (file)

Special Variable: *white-char-count*
Package

read-csv

Source

read-csv.lisp (file)


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

5.2.3 Functions

Function: addc C
Package

read-csv

Source

read-csv.lisp (file)

Function: addl C
Package

read-csv

Source

read-csv.lisp (file)

Function: char-class SEP CHAR
Package

read-csv

Source

read-csv.lisp (file)

Function: next C
Package

read-csv

Source

read-csv.lisp (file)

Function: noop C
Package

read-csv

Source

read-csv.lisp (file)

Function: ship C
Package

read-csv

Source

read-csv.lisp (file)


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

Appendix A Indexes


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

A.1 Concepts

Jump to:   F   L   R  
Index Entry  Section

F
File, Lisp, read-csv.asd: The read-csv<dot>asd file
File, Lisp, read-csv/read-csv.lisp: The read-csv/read-csv<dot>lisp file

L
Lisp File, read-csv.asd: The read-csv<dot>asd file
Lisp File, read-csv/read-csv.lisp: The read-csv/read-csv<dot>lisp file

R
read-csv.asd: The read-csv<dot>asd file
read-csv/read-csv.lisp: The read-csv/read-csv<dot>lisp file

Jump to:   F   L   R  

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

A.2 Functions

Jump to:   A   C   F   N   P   R   S  
Index Entry  Section

A
addc: Internal functions
addl: Internal functions

C
char-class: Internal functions

F
Function, addc: Internal functions
Function, addl: Internal functions
Function, char-class: Internal functions
Function, next: Internal functions
Function, noop: Internal functions
Function, parse-csv: Exported functions
Function, read-csv: Exported functions
Function, ship: Internal functions

N
next: Internal functions
noop: Internal functions

P
parse-csv: Exported functions

R
read-csv: Exported functions

S
ship: Internal functions

Jump to:   A   C   F   N   P   R   S  

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

A.3 Variables

Jump to:   *   +  
C   D   M   Q   R   S   U  
Index Entry  Section

*
*record*: Internal special variables
*records*: Internal special variables
*white-char-count*: Internal special variables

+
+csv-table+: Internal constants

C
Constant, +csv-table+: Internal constants
Constant, done!: Internal constants
Constant, myquo: Internal constants
Constant, q+q&w: Internal constants
Constant, q+quo: Internal constants
Constant, q+ret: Internal constants
Constant, retur: Internal constants
Constant, start: Internal constants
Constant, unquo: Internal constants

D
done!: Internal constants

M
myquo: Internal constants

Q
q+q&w: Internal constants
q+quo: Internal constants
q+ret: Internal constants

R
retur: Internal constants

S
Special Variable, *record*: Internal special variables
Special Variable, *records*: Internal special variables
Special Variable, *white-char-count*: Internal special variables
start: Internal constants

U
unquo: Internal constants

Jump to:   *   +  
C   D   M   Q   R   S   U  

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

A.4 Data types

Jump to:   P   R   S  
Index Entry  Section

P
Package, read-csv: The read-csv package

R
read-csv: The read-csv system
read-csv: The read-csv package

S
System, read-csv: The read-csv system

Jump to:   P   R   S