Safe Haskell	Safe-Inferred
Language	Haskell2010

ParseLib.Error

Contents

configuration
parse error bundle
pretty printing parse error bundles
unbundled parse error
utilities

Synopsis

data Config = Config {
- errorCount :: Int
- symbolsBefore :: Int
- symbolsAfter :: Int
}
defaultConfig :: Config
errorCountSet :: Int -> Config -> Config
symbolsBeforeSet :: Int -> Config -> Config
symbolsAfterSet :: Int -> Config -> Config
newtype ParseErrorBundle symbols = ParseErrorBundle [(WithLength symbols, NonEmpty (BundledParseError symbols))]
data BundledParseError symbols
- = BundledParseError symbols
- | BundledFail String
data WithLength a = WithLength a Int
class Show symbol => ErrorsPretty symbol where
- errorBundlePrettyImproved :: Config -> [symbol] -> ParseErrorBundle [symbol] -> String
errorBundlePretty :: (Ord symbol, Show symbol) => Config -> [symbol] -> ParseErrorBundle [symbol] -> String
traceErrorMessage :: Either String (NonEmpty (a, [s])) -> [(a, [s])]
data ParseError symbols
- = ParseError symbols symbols
- | Fail String symbols
toBundle :: Ord s => [ParseError [s]] -> [(WithLength [s], NonEmpty (BundledParseError [s]))]
toMegaparsecBundle :: Ord s => [s] -> ParseErrorBundle [s] -> Maybe (ParseErrorBundle [s] Void)
toMegaparsecBundled :: Ord s => Int -> (WithLength [s], NonEmpty (BundledParseError [s])) -> [ParseError [s] Void]
toErrorItem :: [s] -> ErrorItem (Token [s])
toBundled :: ParseError symbols -> BundledParseError symbols
inputRestGet :: ParseError symbols -> symbols
groupWithKey :: Ord b => (a -> b) -> [a] -> [(b, NonEmpty a)]

configuration

data Config Source #

Constructors

Config
Fields errorCount :: Int upper limit of positions where to collect errors from. a value of zero turns off error reporting. a negative value causes all errors to be reported. symbolsBefore :: Int upper limit of symbols to show before the offending symbol symbolsAfter :: Int upper limit of symbols to show after the offending symbol

Instances

Instances details

Show Config Source #
Instance details Defined in ParseLib.Error Methods showsPrec :: Int -> Config -> ShowS # show :: Config -> String # showList :: [Config] -> ShowS #
Eq Config Source #
Instance details Defined in ParseLib.Error Methods (==) :: Config -> Config -> Bool # (/=) :: Config -> Config -> Bool #
Ord Config Source #
Instance details Defined in ParseLib.Error Methods compare :: Config -> Config -> Ordering # (<) :: Config -> Config -> Bool # (<=) :: Config -> Config -> Bool # (>) :: Config -> Config -> Bool # (>=) :: Config -> Config -> Bool # max :: Config -> Config -> Config # min :: Config -> Config -> Config #

defaultConfig :: Config Source #

default configuration, setting errorCount to 1, symbolsBefore to 16, and symbolsAfter to 15.

errorCountSet Source #

Arguments

:: Int	new `errorCount`
-> Config
-> Config

set a configuration's errorCount

symbolsBeforeSet Source #

Arguments

:: Int	new `symbolsBefore`
-> Config
-> Config

set a configuration's symbolsBefore

symbolsAfterSet Source #

Arguments

:: Int	new `symbolsAfter`
-> Config
-> Config

set a configuration's symbolsAfter

parse error bundle

newtype ParseErrorBundle symbols Source #

Constructors

ParseErrorBundle [(WithLength symbols, NonEmpty (BundledParseError symbols))]

Instances

Instances details

Show symbols => Show (ParseErrorBundle symbols) Source #
Instance details Defined in ParseLib.Error Methods showsPrec :: Int -> ParseErrorBundle symbols -> ShowS # show :: ParseErrorBundle symbols -> String # showList :: [ParseErrorBundle symbols] -> ShowS #
Eq symbols => Eq (ParseErrorBundle symbols) Source #
Instance details Defined in ParseLib.Error Methods (==) :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> Bool # (/=) :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> Bool #
Ord symbols => Ord (ParseErrorBundle symbols) Source #
Instance details Defined in ParseLib.Error Methods compare :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> Ordering # (<) :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> Bool # (<=) :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> Bool # (>) :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> Bool # (>=) :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> Bool # max :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> ParseErrorBundle symbols # min :: ParseErrorBundle symbols -> ParseErrorBundle symbols -> ParseErrorBundle symbols #

data BundledParseError symbols Source #

Constructors

BundledParseError symbols	expected
BundledFail String	message

Instances

Instances details

Show symbols => Show (BundledParseError symbols) Source #
Instance details Defined in ParseLib.Error Methods showsPrec :: Int -> BundledParseError symbols -> ShowS # show :: BundledParseError symbols -> String # showList :: [BundledParseError symbols] -> ShowS #
Eq symbols => Eq (BundledParseError symbols) Source #
Instance details Defined in ParseLib.Error Methods (==) :: BundledParseError symbols -> BundledParseError symbols -> Bool # (/=) :: BundledParseError symbols -> BundledParseError symbols -> Bool #
Ord symbols => Ord (BundledParseError symbols) Source #
Instance details Defined in ParseLib.Error Methods compare :: BundledParseError symbols -> BundledParseError symbols -> Ordering # (<) :: BundledParseError symbols -> BundledParseError symbols -> Bool # (<=) :: BundledParseError symbols -> BundledParseError symbols -> Bool # (>) :: BundledParseError symbols -> BundledParseError symbols -> Bool # (>=) :: BundledParseError symbols -> BundledParseError symbols -> Bool # max :: BundledParseError symbols -> BundledParseError symbols -> BundledParseError symbols # min :: BundledParseError symbols -> BundledParseError symbols -> BundledParseError symbols #

data WithLength a Source #

Constructors

WithLength a Int

Instances

Instances details

Show a => Show (WithLength a) Source #
Instance details Defined in ParseLib.Error Methods showsPrec :: Int -> WithLength a -> ShowS # show :: WithLength a -> String # showList :: [WithLength a] -> ShowS #
Eq a => Eq (WithLength a) Source #
Instance details Defined in ParseLib.Error Methods (==) :: WithLength a -> WithLength a -> Bool # (/=) :: WithLength a -> WithLength a -> Bool #
Ord a => Ord (WithLength a) Source #
Instance details Defined in ParseLib.Error Methods compare :: WithLength a -> WithLength a -> Ordering # (<) :: WithLength a -> WithLength a -> Bool # (<=) :: WithLength a -> WithLength a -> Bool # (>) :: WithLength a -> WithLength a -> Bool # (>=) :: WithLength a -> WithLength a -> Bool # max :: WithLength a -> WithLength a -> WithLength a # min :: WithLength a -> WithLength a -> WithLength a #

pretty printing parse error bundles

class Show symbol => ErrorsPretty symbol where Source #

Methods

errorBundlePrettyImproved Source #

Arguments

:: Config
-> [symbol]	entire input
-> ParseErrorBundle [symbol]
-> String

pretty prints a ParseErrorBundle like errorBundlePretty but makes error messages bearable for Parser Char. errorBundlePrettyImproved is always preferable to errorBundlePretty.

if you see the following GHC error, you usually need to add a ErrorsPretty constraint to your function.

Overlapping instances for ErrorsPretty
arising from a use of ‘errorBundlePrettyImproved’

Instances

Instances details

ErrorsPretty Char Source #
Instance details Defined in ParseLib.Error Methods errorBundlePrettyImproved :: Config -> [Char] -> ParseErrorBundle [Char] -> String Source #
(Show symbol, Ord symbol) => ErrorsPretty symbol Source #	a `ErrorsPretty` constraint is automatically fulfilled by `Show` instances.
Instance details Defined in ParseLib.Error Methods errorBundlePrettyImproved :: Config -> [symbol] -> ParseErrorBundle [symbol] -> String Source #

errorBundlePretty Source #

Arguments

:: (Ord symbol, Show symbol)
=> Config
-> [symbol]	entire input
-> ParseErrorBundle [symbol]
-> String

pretty prints a ParseErrorBundle like errorBundlePrettyImproved but with much worse error messages for Parser Char. errorBundlePrettyImproved is always preferable to errorBundlePretty.

traceErrorMessage :: Either String (NonEmpty (a, [s])) -> [(a, [s])] Source #

returns [] in the case of Left and prints the String to standard error (stderr) using trace.

unbundled parse error

data ParseError symbols Source #

Constructors

ParseError
Fields symbols expected symbols actual
Fail
Fields String message symbols actual

Instances

Instances details

Eq symbols => Eq (ParseError symbols) Source #
Instance details Defined in ParseLib.Error Methods (==) :: ParseError symbols -> ParseError symbols -> Bool # (/=) :: ParseError symbols -> ParseError symbols -> Bool #

toBundle :: Ord s => [ParseError [s]] -> [(WithLength [s], NonEmpty (BundledParseError [s]))] Source #

utilities

toMegaparsecBundle :: Ord s => [s] -> ParseErrorBundle [s] -> Maybe (ParseErrorBundle [s] Void) Source #

toMegaparsecBundled :: Ord s => Int -> (WithLength [s], NonEmpty (BundledParseError [s])) -> [ParseError [s] Void] Source #

toErrorItem :: [s] -> ErrorItem (Token [s]) Source #

toBundled :: ParseError symbols -> BundledParseError symbols Source #

inputRestGet :: ParseError symbols -> symbols Source #

groupWithKey :: Ord b => (a -> b) -> [a] -> [(b, NonEmpty a)] Source #