TOML.Components

This module provides an intermediate representation for TOML files. The parser produces a list of top-level table components, and this module gathers those together in the form of tables and lists of tables.

Documentation

data Component

Various top-level elements that can be returned by the TOML parser.

Constructors

InitialEntry [(Text, Value)]

key value pairs before any [header]

TableEntry Path [(Text, Value)]

key value pairs after any [header]

ArrayEntry Path [(Text, Value)]

key value pairs after any [[header]]

Instances

Read Component

Methods

readsPrec :: Int -> ReadS Component

readList :: ReadS [Component]

readPrec :: ReadPrec Component

readListPrec :: ReadPrec [Component]

Show Component

Methods

showsPrec :: Int -> Component -> ShowS

show :: Component -> String

showList :: [Component] -> ShowS

type Path = [Text]

Non-empty list of table keys

componentsToTable :: [Component] -> Either Path [(Text, Value)]

Merge a list of top-level components into a single table, or throw an error with an ambiguous path.

collapseComponents :: [Component] -> [(Path, Value)]

Collapse the various components generated by the parser into a single list of path-value pairs. This operations is particularly responsible for gathering top-level array entries together.

splitArrays :: Path -> [Component] -> ([[(Text, Value)]], [Component])

Extract all of the leading ArrayEntry components that match the given path.

factorHeads :: Eq k => [([k], v)] -> [(k, [([k], v)])]

Given a list of key-value pairs ordered by key, group the list by equality on the head of the key-path list.

flattenTableList :: [(Path, Value)] -> Either Path [(Text, Value)]

Flatten a list of path-value pairs into a single table. If in the course of flattening the pairs if the value at a particular path is assigned twice, that path will be returned instead.

mergeInlineTable :: [(Text, value)] -> [(Path, value)] -> [(Path, value)]

Merge a table into the current list of path-value pairs. The resulting list is sorted to make it appropriate for subsequent grouping operations.

order :: [(Path, value)] -> [(Path, value)]

Order a list of path-value pairs lexicographically by path.

validateInlineTables :: Path -> Value -> Either Path ()

Throw an error with the problematic path if a duplicate is found.

findDuplicate :: Ord a => [a] -> Maybe a

Find an entry that appears in the given list more than once.