Music.Theory.Array.Csv

Regular matrix array data, Csv, column & row indexing.

Field / Quote

csv_requires_quote :: String -> Bool

Quoting is required is the string has a double-quote, comma newline or carriage-return.

csv_quote :: String -> String

Quoting places double-quotes at the start and end and escapes double-quotes.

csv_quote_if_req :: String -> String

Quote field if required.

Table

type Csv_Has_Header = Bool

When reading a CSV file is the first row a header?

type Csv_Delimiter = Char

Alias for Char, allow characters other than , as delimiter.

type Csv_Allow_Linebreaks = Bool

Alias for Bool, allow linebreaks in fields.

data Csv_Align_Columns

When writing a CSV file should the delimiters be aligned, ie. should columns be padded with spaces, and if so at which side of the data?

Constructors

Csv_No_Align

Csv_Align_Left

Csv_Align_Right

type Csv_Opt = (Csv_Has_Header, Csv_Delimiter, Csv_Allow_Linebreaks, Csv_Align_Columns)

CSV options.

def_csv_opt :: Csv_Opt

Default CSV options, no header, comma delimiter, no linebreaks, no alignment.

type Csv_Table a = (Maybe [String], Table a)

CSV table, ie. a Table with Maybe a header.

csv_table_read :: Csv_Opt -> (String -> a) -> FilePath -> IO (Csv_Table a)

Read Csv_Table from CSV file.

csv_table_read_def :: (String -> a) -> FilePath -> IO (Table a)

Read Table only with def_csv_opt.

csv_table_read_plain :: FilePath -> IO (Table String)

Read plain CSV Table.

csv_table_with :: Csv_Opt -> (String -> a) -> FilePath -> (Csv_Table a -> b) -> IO b

Read and process CSV Csv_Table.

csv_table_align :: Csv_Align_Columns -> Table String -> Table String

Align table according to Csv_Align_Columns.

csv_table_align Csv_No_Align [["a","row","and"],["then","another","one"]]

csv_table_pp :: (a -> String) -> Csv_Opt -> Csv_Table a -> String

Pretty-print Csv_Table.

csv_table_write :: (a -> String) -> Csv_Opt -> FilePath -> Csv_Table a -> IO ()

write_file_utf8 of csv_table_pp.

csv_table_write_def :: (a -> String) -> FilePath -> Table a -> IO ()

Write Table only (no header) with def_csv_opt.

csv_table_write_plain :: FilePath -> Table String -> IO ()

Write plain CSV Table.

table_lookup :: Table a -> (Int, Int) -> a

0-indexed (row,column) cell lookup.

table_row :: Table a -> Row_Ref -> [a]

Row data.

table_column :: Table a -> Column_Ref -> [a]

Column data.

table_column_lookup :: Eq a => Table a -> (Column_Ref, Column_Ref) -> a -> Maybe a

Lookup value across columns.

table_cell :: Table a -> Cell_Ref -> a

Table cell lookup.

table_lookup_row_segment :: Table a -> (Int, (Int, Int)) -> [a]

0-indexed (row,column) cell lookup over column range.

table_row_segment :: Table a -> (Row_Ref, Column_Range) -> [a]

Range of cells from row.

Array

table_to_array :: Table a -> Array Cell_Ref a

Translate Table to Array. It is assumed that the Table is regular, ie. all rows have an equal number of columns.

let a = table_to_array [[0,1,3],[2,4,5]]
in (bounds a,indices a,elems a)

> (((A,1),(C,2))
> ,[(A,1),(A,2),(B,1),(B,2),(C,1),(C,2)]
> ,[0,2,1,4,3,5])

csv_array_read :: Csv_Opt -> (String -> a) -> FilePath -> IO (Array Cell_Ref a)

table_to_array of csv_table_read.

Irregular

csv_field_str :: CSVField -> String

csv_error_recover :: CSVError -> CSVRow

csv_row_recover :: Either [CSVError] CSVRow -> CSVRow

csv_load_irregular :: (String -> a) -> FilePath -> IO [[a]]

Read irregular CSV file, ie. rows may have any number of columns, including no columns.

csv_write_irregular :: (a -> String) -> Csv_Opt -> FilePath -> Csv_Table a -> IO ()

csv_write_irregular_def :: (a -> String) -> FilePath -> Table a -> IO ()

Tuples

type P2_Parser t1 t2 = (String -> t1, String -> t2)

csv_table_read_p2 :: P2_Parser t1 t2 -> Csv_Opt -> FilePath -> IO (Maybe (String, String), [(t1, t2)])

type P5_Parser t1 t2 t3 t4 t5 = (String -> t1, String -> t2, String -> t3, String -> t4, String -> t5)

type P5_Writer t1 t2 t3 t4 t5 = (t1 -> String, t2 -> String, t3 -> String, t4 -> String, t5 -> String)

csv_table_read_p5 :: P5_Parser t1 t2 t3 t4 t5 -> Csv_Opt -> FilePath -> IO (Maybe [String], [(t1, t2, t3, t4, t5)])

csv_table_write_p5 :: P5_Writer t1 t2 t3 t4 t5 -> Csv_Opt -> FilePath -> (Maybe [String], [(t1, t2, t3, t4, t5)]) -> IO ()

csv_table_read_t9 :: (String -> t) -> Csv_Opt -> FilePath -> IO (Maybe [String], [T9 t])