Safe Haskell	Safe-Inferred
Language	Haskell2010

SimpleParser.Explain

Synopsis

class TextBuildable a where
- buildText :: a -> Builder
newtype ShowTextBuildable a = ShowTextBuildable {
- unShowTextBuildable :: a
}
class ExplainLabel l where
- explainLabel :: l -> Builder
- explainLabelText :: l -> Text
data ErrorExplanation = ErrorExplanation {
- eeReason :: !Text
- eeExpected :: !(Maybe Text)
- eeActual :: !(Maybe Text)
}
class ExplainError e where
- explainError :: e -> ErrorExplanation
type Explainable l s e = (PosStream s, ExplainLabel l, ExplainError e)
data ParseErrorExplanation p = ParseErrorExplanation {
- peeSpan :: !(Span p)
- peeContext :: !(Seq Text)
- peeDetails :: !(Maybe Text)
- peeErrExp :: !ErrorExplanation
}
explainParseError :: (TextBuildable (Token s), TextBuildable (Chunk s), Explainable l s e) => ParseError l s e -> ParseErrorExplanation (Pos s)
buildParseErrorExplanation :: HasLinePos p => ParseErrorExplanation p -> Builder
buildAllParseErrorExplanations :: (HasLinePos p, Foldable f) => f (ParseErrorExplanation p) -> Builder

Documentation

class TextBuildable a where Source #

Types that can be rendered into a textual error message (Effectively a fancy Show)

Methods

buildText :: a -> Builder Source #

Instances

Instances details

TextBuildable Atom Source #
Instance details Defined in SimpleParser.Examples.Common.Sexp Methods buildText :: Atom -> Builder Source #
TextBuildable Text Source #
Instance details Defined in SimpleParser.Explain Methods buildText :: Text -> Builder Source #
TextBuildable Builder Source #
Instance details Defined in SimpleParser.Explain Methods buildText :: Builder -> Builder Source #
TextBuildable String Source #
Instance details Defined in SimpleParser.Explain Methods buildText :: String -> Builder Source #
TextBuildable Char Source #
Instance details Defined in SimpleParser.Explain Methods buildText :: Char -> Builder Source #
TextBuildable a => TextBuildable (Seq a) Source #
Instance details Defined in SimpleParser.Explain Methods buildText :: Seq a -> Builder Source #
Show a => TextBuildable (ShowTextBuildable a) Source #
Instance details Defined in SimpleParser.Explain Methods buildText :: ShowTextBuildable a -> Builder Source #
TextBuildable a => TextBuildable [a] Source #
Instance details Defined in SimpleParser.Explain Methods buildText :: [a] -> Builder Source #

newtype ShowTextBuildable a Source #

Deriving-Via wrapper for TextBuildable for types with Show

Constructors

ShowTextBuildable
Fields unShowTextBuildable :: a

Instances

Instances details

Show a => TextBuildable (ShowTextBuildable a) Source #
Instance details Defined in SimpleParser.Explain Methods buildText :: ShowTextBuildable a -> Builder Source #

class ExplainLabel l where Source #

Minimal complete definition

explainLabel

Methods

explainLabel :: l -> Builder Source #

explainLabelText :: l -> Text Source #

Instances

Instances details

ExplainLabel Void Source #
Instance details Defined in SimpleParser.Explain Methods explainLabel :: Void -> Builder Source # explainLabelText :: Void -> Text Source #
ExplainLabel TextLabel Source #
Instance details Defined in SimpleParser.Explain Methods explainLabel :: TextLabel -> Builder Source # explainLabelText :: TextLabel -> Text Source #
ExplainLabel AstLabel Source #
Instance details Defined in SimpleParser.Examples.Direct.Ast Methods explainLabel :: AstLabel -> Builder Source # explainLabelText :: AstLabel -> Text Source #
ExplainLabel SexpLabel Source #
Instance details Defined in SimpleParser.Examples.Direct.Sexp Methods explainLabel :: SexpLabel -> Builder Source # explainLabelText :: SexpLabel -> Text Source #
ExplainLabel SexpTokLabel Source #
Instance details Defined in SimpleParser.Examples.Lexed.Sexp Methods explainLabel :: SexpTokLabel -> Builder Source # explainLabelText :: SexpTokLabel -> Text Source #
ExplainLabel l => ExplainLabel (CompoundTextLabel l) Source #
Instance details Defined in SimpleParser.Explain Methods explainLabel :: CompoundTextLabel l -> Builder Source # explainLabelText :: CompoundTextLabel l -> Text Source #

data ErrorExplanation Source #

Constructors

ErrorExplanation
Fields eeReason :: !Text eeExpected :: !(Maybe Text) eeActual :: !(Maybe Text)

Instances

Instances details

Show ErrorExplanation Source #
Instance details Defined in SimpleParser.Explain Methods showsPrec :: Int -> ErrorExplanation -> ShowS # show :: ErrorExplanation -> String # showList :: [ErrorExplanation] -> ShowS #
Eq ErrorExplanation Source #
Instance details Defined in SimpleParser.Explain Methods (==) :: ErrorExplanation -> ErrorExplanation -> Bool # (/=) :: ErrorExplanation -> ErrorExplanation -> Bool #

class ExplainError e where Source #

Methods

explainError :: e -> ErrorExplanation Source #

Instances

Instances details

ExplainError Void Source #
Instance details Defined in SimpleParser.Explain Methods explainError :: Void -> ErrorExplanation Source #
(TextBuildable (Token s), TextBuildable (Chunk s)) => ExplainError (StreamError s) Source #
Instance details Defined in SimpleParser.Explain Methods explainError :: StreamError s -> ErrorExplanation Source #
(TextBuildable (Token s), TextBuildable (Chunk s), ExplainError e) => ExplainError (CompoundError s e) Source #
Instance details Defined in SimpleParser.Explain Methods explainError :: CompoundError s e -> ErrorExplanation Source #

type Explainable l s e = (PosStream s, ExplainLabel l, ExplainError e) Source #

data ParseErrorExplanation p Source #

Constructors

ParseErrorExplanation
Fields peeSpan :: !(Span p) peeContext :: !(Seq Text) peeDetails :: !(Maybe Text) peeErrExp :: !ErrorExplanation

Instances

Instances details

Show p => Show (ParseErrorExplanation p) Source #
Instance details Defined in SimpleParser.Explain Methods showsPrec :: Int -> ParseErrorExplanation p -> ShowS # show :: ParseErrorExplanation p -> String # showList :: [ParseErrorExplanation p] -> ShowS #
Eq p => Eq (ParseErrorExplanation p) Source #
Instance details Defined in SimpleParser.Explain Methods (==) :: ParseErrorExplanation p -> ParseErrorExplanation p -> Bool # (/=) :: ParseErrorExplanation p -> ParseErrorExplanation p -> Bool #

explainParseError :: (TextBuildable (Token s), TextBuildable (Chunk s), Explainable l s e) => ParseError l s e -> ParseErrorExplanation (Pos s) Source #

buildParseErrorExplanation :: HasLinePos p => ParseErrorExplanation p -> Builder Source #

buildAllParseErrorExplanations :: (HasLinePos p, Foldable f) => f (ParseErrorExplanation p) -> Builder Source #