Moduletoml-parser-2.0.0.0Haskell2010

Toml.Schema.ParseTable

This module provides utilities for matching key-value pairs out of tables while building up application-specific values.

It will help generate warnings for unused keys, help select between multiple possible keys, and emit location-specific error messages when keys are unavailable.

2 types
8 values

Packagetoml-parser-2.0.0.0
Exports10
LanguageHaskell2010
LicenceISC
SourceParseTable.hs

Base interface

4 declarations

newtypenewtype ParseTable l a

Parser that tracks a current set of unmatched key-value pairs from a table.

Use Toml.Schema.optKey and Toml.Schema.reqKey to extract keys.

Use getTable and setTable to override the table and implement other primitives.

Instances6Monad, Functor, MonadFail, Applicative, Alternative, MonadPlus

Monad (ParseTable l)Defined in toml-parser-2.0.0.0 · Toml.Schema.ParseTable
Functor (ParseTable l)Defined in toml-parser-2.0.0.0 · Toml.Schema.ParseTable
MonadFail (ParseTable l)Defined in toml-parser-2.0.0.0 · Toml.Schema.ParseTable
Implemented in terms of fail on Matcher
Applicative (ParseTable l)Defined in toml-parser-2.0.0.0 · Toml.Schema.ParseTable
Alternative (ParseTable l)Defined in toml-parser-2.0.0.0 · Toml.Schema.ParseTable
MonadPlus (ParseTable l)Defined in toml-parser-2.0.0.0 · Toml.Schema.ParseTable

datadata KeyAlt l a

Key and value matching function

Constructors

Key Text (Value' l -> Matcher l a)
pick alternative based on key match
Else (Matcher l a)
default case when no previous cases matched

valuepickKey :: [KeyAlt l a] -> ParseTable l a

Take the first option from a list of table keys and matcher functions. This operation will commit to the first table key that matches. If the associated matcher fails, only that error will be propagated and the other alternatives will not be matched.

If no keys match, an error message is generated explaining which keys would have been accepted.

This is provided as an alternative to chaining multiple Toml.Schema.reqKey cases together with Alternative which will fall-through as a result of any failure to the next case.

valueparseTable :: ParseTable l a -> l -> Table' l -> Matcher l a

Run a ParseTable computation with a given starting Table'. Unused tables will generate a warning. To change this behavior getTable and setTable can be used to discard or generate error messages.

Primitives

6 declarations

valueliftMatcher :: Matcher l a -> ParseTable l a

Lift a matcher into the current table parsing context.

valuewarnTable :: String -> ParseTable l ()

Emit a warning without an annotation.

valuewarnTableAt :: l -> String -> ParseTable l ()

Emit a warning with the given annotation.

valuefailTableAt :: l -> String -> ParseTable l a

Abort the current table matching with an error message at the given annotation.

valuesetTable :: Table' l -> ParseTable l ()

Replace the remaining portion of the table being matched.

valuegetTable :: ParseTable l (Table' l)

Return the remaining portion of the table being matched.