Text.DelimiterSeparated

The library provides parsing/unparsing of Records as well as interpreting those records to a datatype of your choice, via toRecords and fromRecords using class DelimSepRecord, where each individual field can be interpreted via class DelimSepField.

The following example demonstrates the basic parsing/unparsing:

module Main where

import Text.DelimiterSeparated
import System.IO
import Control.Monad

main = do
  txt <- readFile "data.csv"
  putStrLn txt
  case recordsFromDelimiterSeparated csv txt of
    Left es -> forM_ es putStrLn
    Right recs -> do
      putStrLn $ show recs
      writeFile "data-out-csv.csv" $ recordsToDelimiterSeparated csv recs
      writeFile "data-out-csv.tsv" $ recordsToDelimiterSeparated tsv recs

  txt <- readFile "data.tsv"
  -- putStrLn txt
  case recordsFromDelimiterSeparated tsv txt of
    Left es -> forM_ es putStrLn
    Right recs -> do
      putStrLn $ show recs
      writeFile "data-out-tsv.csv" $ recordsToDelimiterSeparated csv recs

Types

data Field

Field

Constructors

Field

Fields

• fldStr :: String

Instances

Eq Field

Methods

(==) :: Field -> Field -> Bool

(/=) :: Field -> Field -> Bool

Show Field

Methods

showsPrec :: Int -> Field -> ShowS

show :: Field -> String

showList :: [Field] -> ShowS

DelimSepRecord Record

Methods

toDelimSepRecord :: Record -> Record

fromDelimSepRecord :: Record -> Record

DelimSepField Field

Methods

toDelimSepField :: Field -> Field

fromDelimSepField :: Field -> Field

type Record = [Field]

Record is sequence of fields (representation may change in future)

type Records = [Record]

Records is sequence of records (representation may change in future)

data DelimiterStyle

Style of delimitation

Constructors

CSV

Fields

• styleFieldDelimChars :: [Char]
• styleRecordDelimChars :: [Char]

TSV

csv :: DelimiterStyle

Predefined delimiter style for comma field separated, newline/return record separated

tsv :: DelimiterStyle

Predefined delimiter style for tab field separated, newline/return record separated

Construction

emptyField :: Field

Empty field

Encoding, decoding

recordsToDelimiterSeparated :: DelimiterStyle -> Records -> String

Encode internal representation in external delimiter separated format

recordsFromDelimiterSeparated :: DelimiterStyle -> String -> Either [String] Records

Decode internal representation from external delimiter separated format, possible failing with error messages

Checks, fixes

data Check

Which checks are to be done by recordsCheck

Constructors

Check_DupHdrNms

check for duplicate header names

Check_EqualSizedRecs

check for equal sized records (ignoring possible header)

Check_AtLeast1Rec

check for at least 1 record (ignoring possible header)

Check_EqualSizedHdrRecs

check for equal sized header and records

Check_NoRecsLargerThanHdr

check for records not larger than header

Check_NoRecsSmallerThanHdr

check for records not smaller than header

Instances

Bounded Check

Methods

minBound :: Check

maxBound :: Check

Enum Check

Methods

succ :: Check -> Check

pred :: Check -> Check

toEnum :: Int -> Check

fromEnum :: Check -> Int

enumFrom :: Check -> [Check]

enumFromThen :: Check -> Check -> [Check]

enumFromTo :: Check -> Check -> [Check]

enumFromThenTo :: Check -> Check -> Check -> [Check]

Eq Check

Methods

(==) :: Check -> Check -> Bool

(/=) :: Check -> Check -> Bool

checkAll :: [Check]

All checks

recordsCheck :: Bool -> [Check] -> Records -> Maybe String

Check records, possibly yielding errors

data Fix

Which fixes are to be done by recordsCheck

Constructors

Fix_Pad

pad

Fix_PadToHdrLen

in combi with pad, pad to header len

Instances

Bounded Fix

Methods

minBound :: Fix

maxBound :: Fix

Enum Fix

Methods

succ :: Fix -> Fix

pred :: Fix -> Fix

toEnum :: Int -> Fix

fromEnum :: Fix -> Int

enumFrom :: Fix -> [Fix]

enumFromThen :: Fix -> Fix -> [Fix]

enumFromTo :: Fix -> Fix -> [Fix]

enumFromThenTo :: Fix -> Fix -> Fix -> [Fix]

Eq Fix

Methods

(==) :: Fix -> Fix -> Bool

(/=) :: Fix -> Fix -> Bool

recordsFix :: Bool -> [Fix] -> Records -> Records

Fix sizes of records by padding to max size

Construction

recordsFromHeaderStr :: String -> Records

Convert a String representation of a header to actual record

recordsAddHeaderStr :: String -> Records -> Records

Add a header described by string holding whitespaced separated labels

Manipulation

recordsPartitionRows :: Bool -> ([String] -> Bool) -> Records -> (Records, Records)

Partition record rows. Fst of tuple holds the possible header, if indicated it is present. Snd of tuple holds records failing the predicate. Assumes >0 records

recordsPartitionColsBasedOnHeader :: (String -> Bool) -> Records -> (Records, Records)

Partition record columns, fst of tuple holds the obligatory header upon wich partitioning is done Assumes header and records all have same nr of fields

recordsSpan :: Bool -> ([String] -> Bool) -> Records -> (Records, Records)

Partition records, fst of tuple holds the possible header, if indicated it is present. Assumes >0 records

recordsSplitHeader :: Records -> (Record, Records)

Split of header, assuming there is one

Conversion

recordsToStrings :: Records -> [[String]]

Get all fields as strings

recordsFromStrings :: [[String]] -> Records

Lift strings as Records

Overloaded conversion

class DelimSepField x where

Conversion tofrom Field, i.e. kinda showread

Minimal complete definition

toDelimSepField, fromDelimSepField

Methods

toDelimSepField :: x -> Field

fromDelimSepField :: Field -> x

Instances

DelimSepField Double

Methods

toDelimSepField :: Double -> Field

fromDelimSepField :: Field -> Double

DelimSepField Int

Methods

toDelimSepField :: Int -> Field

fromDelimSepField :: Field -> Int

DelimSepField Integer

Methods

toDelimSepField :: Integer -> Field

fromDelimSepField :: Field -> Integer

DelimSepField String

Methods

toDelimSepField :: String -> Field

fromDelimSepField :: Field -> String

DelimSepField Field

Methods

toDelimSepField :: Field -> Field

fromDelimSepField :: Field -> Field

DelimSepField x => DelimSepField [x]

Methods

toDelimSepField :: [x] -> Field

fromDelimSepField :: Field -> [x]

class DelimSepRecord x where

Conversion to/from Record

Minimal complete definition

toDelimSepRecord, fromDelimSepRecord

Methods

toDelimSepRecord :: x -> Record

fromDelimSepRecord :: Record -> x

Instances

DelimSepRecord Record

Methods

toDelimSepRecord :: Record -> Record

fromDelimSepRecord :: Record -> Record

toRecords :: DelimSepRecord x => [x] -> Records

Convert to records

toRecordsWithHeader :: DelimSepRecord x => [Record] -> [x] -> Records

Convert to records, with a header described by string holding whitespaced separated labels

toRecordsWithHeaderStr :: DelimSepRecord x => String -> [x] -> Records

Convert to records, with a header described by string holding whitespaced separated labels

fromRecords :: DelimSepRecord x => Records -> [x]

Convert from records