The vellum-csv Reference Manual

This is the vellum-csv Reference Manual, version 1.0.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Sat Dec 03 23:40:30 2022 GMT+0.

Table of Contents


1 Introduction


2 Systems

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


2.1 vellum-csv

CSV support for Vellum Data Frames

Author

Marek Kochanowicz

License

BSD simplified

Version

1.0.0

Dependencies
  • iterate (system).
  • serapeum (system).
  • uiop (system).
  • vellum (system)., at least version ((>= "1.2.0"))
  • parse-float (system).
  • alexandria (system).
  • documentation-utils-extensions (system).
Source

vellum-csv.asd.

Child Components

3 Files

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


3.1 Lisp


3.1.1 vellum-csv/vellum-csv.asd

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

ASDF Systems

vellum-csv.


3.1.2 vellum-csv/package.lisp

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Packages

vellum-csv.


3.1.3 vellum-csv/csv.lisp

Dependency

package.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface
Internals

3.1.4 vellum-csv/generics.lisp

Dependency

csv.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface

3.1.5 vellum-csv/types.lisp

Dependency

generics.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface
Internals

3.1.6 vellum-csv/functions.lisp

Dependency

types.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface

csv-range (function).


3.1.7 vellum-csv/implementation.lisp

Dependency

functions.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface
Internals

with-stream-input (macro).


4 Packages

Packages are listed by definition order.


4.1 vellum-csv

Source

package.lisp.

Use List
  • common-lisp.
  • vellum.aux-package.
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: csv-range (path &key includes-header-p header separator quote escape)
Package

vellum-csv.

Source

functions.lisp.

Function: write-csv-field (field stream)
Package

vellum-csv.

Source

csv.lisp.

Function: write-csv-line (fields stream)

Format one line of FIELDS to STREAM in CSV format, using the current syntax parameters.

Package

vellum-csv.

Source

csv.lisp.


5.1.2 Generic functions

Generic Function: from-string (data-type string start end)
Package

vellum-csv.

Source

generics.lisp.

Methods
Method: from-string ((type (eql boolean)) string start end)
Source

implementation.lisp.

Method: from-string (type string start end)
Source

implementation.lisp.

Method: from-string ((type (eql t)) string start end)
Source

implementation.lisp.

Method: from-string ((type (eql double-float)) string start end)
Source

implementation.lisp.

Method: from-string ((type (eql single-float)) string start end)
Source

implementation.lisp.

Method: from-string ((type (eql float)) string start end)
Source

implementation.lisp.

Method: from-string ((type (eql string)) string start end)
Source

implementation.lisp.

Method: from-string ((type (eql integer)) string start end)
Source

implementation.lisp.

Method: from-string ((type (eql fixnum)) string start end)
Source

implementation.lisp.

Method: from-string ((type (eql number)) string start end)
Source

implementation.lisp.

Method: from-string :around (type string start end)
Source

implementation.lisp.

Generic Function: to-string (data-type value)
Package

vellum-csv.

Source

generics.lisp.

Methods
Method: to-string ((type (eql boolean)) value)
Source

implementation.lisp.

Method: to-string (type value)
Source

implementation.lisp.

Method: to-string :around (type value)
Source

implementation.lisp.


5.1.3 Standalone methods

Method: across ((object csv-range) function)
Package

cl-data-structures.

Source

implementation.lisp.

Method: cloning-information append ((object csv-range))
Package

cl-data-structures.utils.

Source

types.lisp.

Method: traverse ((object csv-range) function)
Package

cl-data-structures.

Source

implementation.lisp.


5.1.4 Classes

Class: csv-range
Package

vellum-csv.

Source

types.lisp.

Direct superclasses
  • frame-range-mixin.
  • traversable.
Direct methods
Direct slots
Slot: %includes-header-p
Initargs

:includes-header-p

Readers

includes-header-p.

Writers

This slot is read-only.

Slot: %path
Initargs

:path

Readers

path.

Writers

This slot is read-only.

Slot: %separator
Initargs

:separator

Readers

separator.

Writers

This slot is read-only.

Slot: %quote
Initargs

:quote

Readers

csv-quote.

Writers

This slot is read-only.

Slot: %escape
Initargs

:escape

Readers

escape.

Writers

This slot is read-only.


5.2 Internals


5.2.1 Constants

Constant: +buffer-size+
Package

vellum-csv.

Source

csv.lisp.

Constant: +cr+
Package

vellum-csv.

Source

csv.lisp.

Constant: +crlf+
Package

vellum-csv.

Source

csv.lisp.

Constant: +lf+
Package

vellum-csv.

Source

csv.lisp.


5.2.2 Special variables

Special Variable: *csv-variables*
Package

vellum-csv.

Source

csv.lisp.

Special Variable: *eol*

line ending when exporting CSV

Package

vellum-csv.

Source

csv.lisp.

Special Variable: *escape*

Character used for escaping strings.

Package

vellum-csv.

Source

csv.lisp.

Special Variable: *quote*

delimiter of string data; pascal-like quoted as double itself in a string.

Package

vellum-csv.

Source

csv.lisp.

Special Variable: *separator*

Separator between CSV fields

Package

vellum-csv.

Source

csv.lisp.

Special Variable: *skip-whitespace*

Should whitespace be skipped

Package

vellum-csv.

Source

csv.lisp.


5.2.3 Macros

Macro: with-stream-input ((stream range) &body body)
Package

vellum-csv.

Source

implementation.lisp.


5.2.4 Ordinary functions

Function: char-ascii-text-p (c)
Package

vellum-csv.

Source

csv.lisp.

Function: char-needs-quoting (x)
Package

vellum-csv.

Source

csv.lisp.

Function: char-space-p (separator c)

Is character C some kind of white space?
NB: this only handles a tiny subset of whitespace characters, even if restricted to ASCII. However, it’s rather portable, and is what the creativyst document specifies.
Be careful to not skip a separator, as it could be e.g. a tab!

Package

vellum-csv.

Source

csv.lisp.

Function: csv-to-list (string separator quote escape)
Package

vellum-csv.

Source

csv.lisp.

Function: read-csv (stream row-callback column-callback separator quote escape)
Package

vellum-csv.

Source

csv.lisp.

Function: string-needs-quoting (x)
Package

vellum-csv.

Source

csv.lisp.

Function: valid-eol-p (x)
Package

vellum-csv.

Source

csv.lisp.

Function: validate-csv-parameters ()
Package

vellum-csv.

Source

csv.lisp.

Function: write-csv-string-safely (string stream)
Package

vellum-csv.

Source

csv.lisp.

Function: write-quoted-string (string stream)
Package

vellum-csv.

Source

csv.lisp.


5.2.5 Generic functions

Generic Reader: csv-quote (object)
Package

vellum-csv.

Methods
Reader Method: csv-quote ((csv-range csv-range))

automatically generated reader method

Source

types.lisp.

Target Slot

%quote.

Generic Reader: escape (object)
Package

vellum-csv.

Methods
Reader Method: escape ((csv-range csv-range))

automatically generated reader method

Source

types.lisp.

Target Slot

%escape.

Generic Reader: includes-header-p (object)
Package

vellum-csv.

Methods
Reader Method: includes-header-p ((csv-range csv-range))

automatically generated reader method

Source

types.lisp.

Target Slot

%includes-header-p.

Generic Reader: path (object)
Package

vellum-csv.

Methods
Reader Method: path ((csv-range csv-range))

automatically generated reader method

Source

types.lisp.

Target Slot

%path.

Generic Reader: separator (object)
Package

vellum-csv.

Methods
Reader Method: separator ((csv-range csv-range))

automatically generated reader method

Source

types.lisp.

Target Slot

%separator.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

A
across: Public standalone methods

C
char-ascii-text-p: Private ordinary functions
char-needs-quoting: Private ordinary functions
char-space-p: Private ordinary functions
cloning-information: Public standalone methods
csv-quote: Private generic functions
csv-quote: Private generic functions
csv-range: Public ordinary functions
csv-to-list: Private ordinary functions

E
escape: Private generic functions
escape: Private generic functions

F
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
from-string: Public generic functions
Function, char-ascii-text-p: Private ordinary functions
Function, char-needs-quoting: Private ordinary functions
Function, char-space-p: Private ordinary functions
Function, csv-range: Public ordinary functions
Function, csv-to-list: Private ordinary functions
Function, read-csv: Private ordinary functions
Function, string-needs-quoting: Private ordinary functions
Function, valid-eol-p: Private ordinary functions
Function, validate-csv-parameters: Private ordinary functions
Function, write-csv-field: Public ordinary functions
Function, write-csv-line: Public ordinary functions
Function, write-csv-string-safely: Private ordinary functions
Function, write-quoted-string: Private ordinary functions

G
Generic Function, csv-quote: Private generic functions
Generic Function, escape: Private generic functions
Generic Function, from-string: Public generic functions
Generic Function, includes-header-p: Private generic functions
Generic Function, path: Private generic functions
Generic Function, separator: Private generic functions
Generic Function, to-string: Public generic functions

I
includes-header-p: Private generic functions
includes-header-p: Private generic functions

M
Macro, with-stream-input: Private macros
Method, across: Public standalone methods
Method, cloning-information: Public standalone methods
Method, csv-quote: Private generic functions
Method, escape: Private generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, from-string: Public generic functions
Method, includes-header-p: Private generic functions
Method, path: Private generic functions
Method, separator: Private generic functions
Method, to-string: Public generic functions
Method, to-string: Public generic functions
Method, to-string: Public generic functions
Method, traverse: Public standalone methods

P
path: Private generic functions
path: Private generic functions

R
read-csv: Private ordinary functions

S
separator: Private generic functions
separator: Private generic functions
string-needs-quoting: Private ordinary functions

T
to-string: Public generic functions
to-string: Public generic functions
to-string: Public generic functions
to-string: Public generic functions
traverse: Public standalone methods

V
valid-eol-p: Private ordinary functions
validate-csv-parameters: Private ordinary functions

W
with-stream-input: Private macros
write-csv-field: Public ordinary functions
write-csv-line: Public ordinary functions
write-csv-string-safely: Private ordinary functions
write-quoted-string: Private ordinary functions