Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/iraikov/chicken-csv-abnf
Parsing and formatting of comma-separated values (CSV) according to RFC 4180
https://github.com/iraikov/chicken-csv-abnf
abnf csv parser-combinators scheme
Last synced: 6 days ago
JSON representation
Parsing and formatting of comma-separated values (CSV) according to RFC 4180
- Host: GitHub
- URL: https://github.com/iraikov/chicken-csv-abnf
- Owner: iraikov
- License: gpl-3.0
- Created: 2018-09-14T14:10:54.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2019-05-05T22:31:28.000Z (almost 6 years ago)
- Last Synced: 2024-12-03T15:36:33.844Z (2 months ago)
- Topics: abnf, csv, parser-combinators, scheme
- Language: Scheme
- Size: 18.6 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
csv-abnf
-------
### Description
The library contains procedures for parsing and formatting of
comma-separated values (CSV) as described in [RFC
4180](http://tools.ietf.org/html/rfc4180). There are several
differences with the RFC:
- The RFC prescribes CRLF standard network line breaks, but many CSV files have platform-dependent line endings, so this library accepts any sequence of CRs and LFs as a line break.
- The format of header lines is exactly like a regular record and the presence of a header can only be determined from the mime type. This library treats all lines as regular records.
- The formal grammar specifies that fields can contain only certain US ASCII characters, but the specification of the MIME type allows for other character sets. This library allow all characters in fields, except for the field delimiter character, CRs and LFs in unquoted fields.
- According to the RFC, the records all have to have the same length. This library allows variable length records.
- The delimiter character is specified by the user and can be a character other than comma, or an SRFI-14 character set.
### Library Procedures
(csv-record? X) => BOOL
Returns {{#t}} if the given object is a csv record, {{#f}} otherwise.
(list->csv-record LIST) => CSV-RECORD
Takes in a list of values and creates a object.
(csv-record->list CSV-RECORD) => LIST
Returns the list of values contained in the given object.
#### Parsing Procedures:
(csv-parser \[DELIMITER\]) => PARSER
When invoked, returns a parser procedure takes in a list of characters
and returns a list of the form:
((<#csv-record (FIELD1 FIELD2 ...)>) (<#csv-record ... >))
where represents the field values in a record.
Optional argument DELIMITER is the field delimiter character, if other than
comma.
(make-parser CSV-INSTANCE) => (LAMBDA \[DELIMITER\]) => PARSER
Once applied to an instance of the {{}} typeclass, returns a
constructor for the CSV parsing procedure. Optional argument specifies
the field delimiter (comma by default). can be a character, or an
SRFI-14 character set. The returned procedure takes in an input stream
and returns a list of the form:
#### Formatting procedures
(make-format \[DELIMITER\]) => FORMAT-CELL \* FORMAT-RECORD \* FORMAT-CSV
Returns procedures for outputting individual field values, CSV records,
and lists of CSV records, where each list is printed on a separate line.
Procedure takes in a value, obtains its string representation via , and
surrounds the string with quotes, if it contains characters that need to
be escaped (such as quote characters, the delimiter character, or
newlines).
Procedure takes in a record of type and returns its string
representation, based on the strings produced by and the delimiter
character.
Procedure takes in a list of objects and produces a string
representation using .
Example:
```scheme
(import csv-abnf)
(define-values (fmt-cell fmt-record fmt-csv) (make-format “;”))
(fmt-cell “hello”) => “hello”
; This is quoted because it contains delimiter-characters
(fmt-cell “one;two;three”) => “\\”one;two;three\\""
; This is quoted because it contains quotes, which are then doubled for escaping
(fmt-cell “say \\”hi\\"") => “\\”say \\“\\”hi\\“\\”\\""
; Converts one line at a time (useful when converting data in a streaming manner)
(fmt-record (list->csv-record '(“hi there” “let's say \\”hello
world\\" again" “until we are bored”))) => “hi there;\\”let's say
\\“\\”hello world\\“\\” again\\“;until we are bored”
; And an example of how to quickly convert a list of lists\
; to a CSV string containing the entire CSV file
(fmt-csv (map list->csv-record
```
### Author
Copyright 2009-2019 Ivan Raikov