The csv-parser Reference Manual

3.1.1 csv-parser/csv-parser.asd

Source

csv-parser.asd.

Parent Component

csv-parser (system).

ASDF Systems

csv-parser.

---

3.1.2 csv-parser/csv-parser.lisp

Source

csv-parser.asd.

Parent Component

csv-parser (system).

Packages

csv-parser.

Public Interface

• *field-separator* (special variable).
• *quote-character* (special variable).
• do-csv-file (macro).
• map-csv-file (function).
• read-csv-line (function).
• write-csv-line (function).

Internals

• *current-field* (special variable).
• *fields* (special variable).
• *num-fields* (special variable).
• *spaces-gobbled* (special variable).
• *state* (special variable).
• add-char (function).
• change-state (function).
• csv-test-blank (function).
• csv-test-blanks (function).
• csv-test-double-quotes (function).
• csv-test-embedded-commas (function).
• csv-test-embedded-lines (function).
• csv-test-empty (function).
• csv-test-empty-1 (function).
• csv-test-other-delimiters (function).
• csv-test-quoted (function).
• csv-test-round-trip1 (function).
• csv-test-round-trips (function).
• csv-test-simple (function).
• csv-test-space-handling (function).
• csv-tests (function).
• emit-field (function).
• end-of-field-char-p (function).
• end-of-line-char-p (function).
• got-first-quote (function).
• got-second-quote (function).
• make-empty-field (function).
• quote-char-p (function).
• regular-field (function).
• remove-last-n-chars (function).
• skip-white-space (function).
• special-char-p (function).
• white-space-char-p (function).
• write-csv-field (function).
• write-csv-line-on-array (function).
• write-csv-line-on-cons (function).
• write-csv-string-safely (function).
• write-protected-copy (function).

---

5.1.1 Special variables

Special Variable: *field-separator* ¶

The character used to indicate the end of a field in a CSV file.

Package

csv-parser.

Source

csv-parser.lisp.

Special Variable: *quote-character* ¶

The character used to protect embedded field separators (usually commas) and whitespace within a field.

To import the *quote-character* itself, you must have it printed twice in the input stream.

Package

csv-parser.

Source

csv-parser.lisp.

---

5.1.2 Macros

Macro: do-csv-file (((fields num-fields) file &key limit skip-lines external-format field-separator quote-character) &body body) ¶

Repeatedly call BODY on CSV file FILE, binding
FIELDS and NUM-FIELDS to a list containing the parsed fields, and the number of fields.
Code runs inside a block with tagname NIL, so you
may call (RETURN).

*FIELD-SEPARATOR* and *QUOTE-CHARACTER* can be bound to modify what separates fields and delimits fields.

Package

csv-parser.

Source

csv-parser.lisp.

---

5.1.3 Ordinary functions

Function: map-csv-file (file fn &key limit skip-lines external-format field-separator quote-character) ¶

Call FN (up to LIMIT times, if specified) with
a list containing the fields parsed from the CSV file FILE.

SKIP-LINES, if provided, is the number of lines to skip before starting to call FN.

*FIELD-SEPARATOR* and *QUOTE-CHARACTER* can be bound to modify what separates fields and delimits fields.

Package

csv-parser.

Source

csv-parser.lisp.

Function: read-csv-line (stream) ¶

Read one line form a stream containing CSV data. Returns two values; a list of strings parsed, and the number of parsed values.

Package

csv-parser.

Source

csv-parser.lisp.

Function: write-csv-line (stream fields) ¶

Write one CSV line to STREAM, containing fields.
FIELDS is any (1d) sequence containing strings, symbols or numbers.

Try to write it as esthetically pleasing as possible,
i.e. don’t output the *quote-character* unless necessary
to protect the integrity of the data.

Package

csv-parser.

Source

csv-parser.lisp.

---

5.2.1 Special variables

Special Variable: *current-field* ¶

Holds the field we are currently working on.

Package

csv-parser.

Source

csv-parser.lisp.

Special Variable: *fields* ¶

Holds the fields we have collected/parsed so far.

Package

csv-parser.

Source

csv-parser.lisp.

Special Variable: *num-fields* ¶

Package

csv-parser.

Source

csv-parser.lisp.

Special Variable: *spaces-gobbled* ¶

Keeps track of how many blanks have been skipped. When emitting
a field, we can trim extra right spaces, if appropriate, using this.

Package

csv-parser.

Source

csv-parser.lisp.

Special Variable: *state* ¶

Holds a function which knows how to handle chars based on what we’ve seen so far.

Package

csv-parser.

Source

csv-parser.lisp.

---

5.2.2 Ordinary functions

Function: add-char (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: change-state (state) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-blank () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-blanks () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-double-quotes () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-embedded-commas () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-embedded-lines () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-empty () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-empty-1 () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-other-delimiters () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-quoted () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-round-trip1 (row) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-round-trips () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-simple () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-test-space-handling () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: csv-tests () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: emit-field () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: end-of-field-char-p (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: end-of-line-char-p (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: got-first-quote (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: got-second-quote (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: make-empty-field () ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: quote-char-p (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: regular-field (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: remove-last-n-chars (n) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: skip-white-space (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: special-char-p (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: white-space-char-p (char) ¶

Package

csv-parser.

Source

csv-parser.lisp.

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

Package

csv-parser.

Source

csv-parser.lisp.

Function: write-csv-line-on-array (stream fields) ¶

Package

csv-parser.

Source

csv-parser.lisp.

Function: write-csv-line-on-cons (stream fields) ¶

Package

csv-parser.

Source

csv-parser.lisp.

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

Package

csv-parser.

Source

csv-parser.lisp.

Function: write-protected-copy (stream field) ¶

Package

csv-parser.

Source

csv-parser.lisp.

---