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 Wed May 15 07:17:03 2024 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/variables.lisp

Dependency

package.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface

*null-strings* (special variable).

Internals

*column-index* (special variable).


3.1.4 vellum-csv/csv.lisp

Dependency

variables.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface
Internals

3.1.5 vellum-csv/generics.lisp

Dependency

csv.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface

3.1.6 vellum-csv/types.lisp

Dependency

generics.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface
Internals

3.1.7 vellum-csv/functions.lisp

Dependency

types.lisp (file).

Source

vellum-csv.asd.

Parent Component

vellum-csv (system).

Public Interface

3.1.8 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 Special variables

Special Variable: *null-strings*
Package

vellum-csv.

Source

variables.lisp.


5.1.2 Ordinary functions

Function: csv-range (path &key includes-header-p header separator quote escape null-strings)
Package

vellum-csv.

Source

functions.lisp.

Function: place-null (&optional condition)
Package

vellum-csv.

Source

functions.lisp.

Function: place-value (value)
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.3 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.4 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.5 Conditions

Condition: could-not-parse
Package

vellum-csv.

Source

types.lisp.

Direct superclasses

error.

Direct methods
Direct slots
Slot: %buffer
Initargs

:buffer

Readers

buffer.

Writers

This slot is read-only.

Slot: %start
Initargs

:start

Readers

start.

Writers

This slot is read-only.

Slot: %end
Initargs

:end

Readers

end.

Writers

This slot is read-only.

Slot: %column-index
Initargs

:column-index

Readers

column-index.

Writers

This slot is read-only.

Slot: %column-type
Initargs

:column-type

Readers

column-type.

Writers

This slot is read-only.

Slot: %original-error
Initargs

:original-error

Readers

original-error.

Writers

This slot is read-only.


5.1.6 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: %null-strings
Initargs

:null-strings

Readers

null-strings.

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: *column-index*
Package

vellum-csv.

Source

variables.lisp.

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: buffer (condition)
Package

vellum-csv.

Methods
Reader Method: buffer ((condition could-not-parse))
Source

types.lisp.

Target Slot

%buffer.

Generic Reader: column-index (condition)
Package

vellum-csv.

Methods
Reader Method: column-index ((condition could-not-parse))
Source

types.lisp.

Target Slot

%column-index.

Generic Reader: column-type (condition)
Package

vellum-csv.

Methods
Reader Method: column-type ((condition could-not-parse))
Source

types.lisp.

Target Slot

%column-type.

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: end (condition)
Package

vellum-csv.

Methods
Reader Method: end ((condition could-not-parse))
Source

types.lisp.

Target Slot

%end.

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: null-strings (object)
Package

vellum-csv.

Methods
Reader Method: null-strings ((csv-range csv-range))

automatically generated reader method

Source

types.lisp.

Target Slot

%null-strings.

Generic Reader: original-error (condition)
Package

vellum-csv.

Methods
Reader Method: original-error ((condition could-not-parse))
Source

types.lisp.

Target Slot

%original-error.

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.

Generic Reader: start (condition)
Package

vellum-csv.

Methods
Reader Method: start ((condition could-not-parse))
Source

types.lisp.

Target Slot

%start.


Appendix A Indexes


A.1 Concepts


A.2 Functions

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

A
across: Public standalone methods

B
buffer: Private generic functions
buffer: Private generic functions

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
column-index: Private generic functions
column-index: Private generic functions
column-type: Private generic functions
column-type: Private generic functions
csv-quote: Private generic functions
csv-quote: Private generic functions
csv-range: Public ordinary functions
csv-to-list: Private ordinary functions

E
end: Private generic functions
end: Private generic functions
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, place-null: Public ordinary functions
Function, place-value: Public 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, buffer: Private generic functions
Generic Function, column-index: Private generic functions
Generic Function, column-type: Private generic functions
Generic Function, csv-quote: Private generic functions
Generic Function, end: 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, null-strings: Private generic functions
Generic Function, original-error: Private generic functions
Generic Function, path: Private generic functions
Generic Function, separator: Private generic functions
Generic Function, start: 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, buffer: Private generic functions
Method, cloning-information: Public standalone methods
Method, column-index: Private generic functions
Method, column-type: Private generic functions
Method, csv-quote: Private generic functions
Method, end: 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, null-strings: Private generic functions
Method, original-error: Private generic functions
Method, path: Private generic functions
Method, separator: Private generic functions
Method, start: 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

N
null-strings: Private generic functions
null-strings: Private generic functions

O
original-error: Private generic functions
original-error: Private generic functions

P
path: Private generic functions
path: Private generic functions
place-null: Public ordinary functions
place-value: Public ordinary functions

R
read-csv: Private ordinary functions

S
separator: Private generic functions
separator: Private generic functions
start: Private generic functions
start: 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


A.3 Variables

Jump to:   %   *   +  
C   S  
Index Entry  Section

%
%buffer: Public conditions
%column-index: Public conditions
%column-type: Public conditions
%end: Public conditions
%escape: Public classes
%includes-header-p: Public classes
%null-strings: Public classes
%original-error: Public conditions
%path: Public classes
%quote: Public classes
%separator: Public classes
%start: Public conditions

*
*column-index*: Private special variables
*csv-variables*: Private special variables
*eol*: Private special variables
*escape*: Private special variables
*null-strings*: Public special variables
*quote*: Private special variables
*separator*: Private special variables
*skip-whitespace*: Private special variables

+
+buffer-size+: Private constants
+cr+: Private constants
+crlf+: Private constants
+lf+: Private constants

C
Constant, +buffer-size+: Private constants
Constant, +cr+: Private constants
Constant, +crlf+: Private constants
Constant, +lf+: Private constants

S
Slot, %buffer: Public conditions
Slot, %column-index: Public conditions
Slot, %column-type: Public conditions
Slot, %end: Public conditions
Slot, %escape: Public classes
Slot, %includes-header-p: Public classes
Slot, %null-strings: Public classes
Slot, %original-error: Public conditions
Slot, %path: Public classes
Slot, %quote: Public classes
Slot, %separator: Public classes
Slot, %start: Public conditions
Special Variable, *column-index*: Private special variables
Special Variable, *csv-variables*: Private special variables
Special Variable, *eol*: Private special variables
Special Variable, *escape*: Private special variables
Special Variable, *null-strings*: Public special variables
Special Variable, *quote*: Private special variables
Special Variable, *separator*: Private special variables
Special Variable, *skip-whitespace*: Private special variables