Cookbook.Project.Quill.Quill

A library for reading simple databases. As what was originally a quirk of the library, database tables can be split up and still parsed as if they were a unit, giving it the ability to read the same table from multiple files in parallel. Quill supports a comment syntax, whitespace-insignificant parsing, and a full CRUD API. Quill will EVENTUALLY be replaced by Scribe2, but the planning for Scribe2 has not yet begun.

Documentation

data Table

A table is a record of a name and the information within it.

Constructors

Table

Fields

name :: String

info :: [(String, String)]

prepare :: [String] -> String

Sanitizes strings for Quill processing. Removes comments, newlines, and flattens it into a string.

tokenize :: [a] -> [(a, a)]

Splits a list into tupples.

tblNames :: String -> [String]

Returns the names of all tables in the file.

headlessData :: String -> [[String]]

• Should not be used raw except for API programming. Really shouldn't be included, but too lazy to enumerate top-level declarations for selective export* Returns all entry lines from within tables in database.

tokenLists :: [[String]] -> [[(String, String)]]

Returns all of the tokens from headlessData.

tables :: [String] -> [(String, [(String, String)])]

Creates a listing of all tables in the file.

getTable :: [(String, [(String, String)])] -> String -> [(String, String)]

Gets a particular table in the file, returning its key-value pairs.

lookUp :: [(String, [(String, String)])] -> (String, String) -> [String]

Gets the particular item within a table from a database.

createTable :: [(String, [(String, String)])] -> String -> [(String, [(String, String)])]

Creates a new table within the database.

removeTable :: [(String, [(String, String)])] -> String -> [(String, [(String, String)])]

Removes an entire table from the database by name.

removeItem :: [(String, [(String, String)])] -> (String, String) -> [(String, [(String, String)])]

Removes a particular item from a table within a database.

addItem :: [(String, [(String, String)])] -> String -> (String, String) -> [(String, [(String, String)])]

Adds an item to a table within a database.

changeItem :: [(String, [(String, String)])] -> (String, String) -> String -> [(String, [(String, String)])]

Changes an item within a table. The identifier will remain the same; only the rvalue will change.

tableToString :: (String, [(String, String)]) -> String

Basically a toString function for Quill tables. It turns data into a String format which can be parsed by the Quill parsing stack.