Text.PariPari.Internal.Reporter

Documentation

newtype Reporter k a

Parser which is optimised for good error reports. Performance is secondary, since the Reporter is used as a fallback to the Acceptor.

Constructors

Reporter

Fields

• unReporter :: forall b. Env k -> State -> (a -> State -> b) -> (State -> b) -> b

Instances

Chunk k => Parser k (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

getFile :: Reporter k FilePath

getPos :: Reporter k Pos

getRefPos :: Reporter k Pos

withRefPos :: Reporter k a -> Reporter k a

notFollowedBy :: Show a => Reporter k a -> Reporter k ()

lookAhead :: Reporter k a -> Reporter k a

failWith :: Error -> Reporter k a

eof :: Reporter k ()

label :: String -> Reporter k a -> Reporter k a

hidden :: Reporter k a -> Reporter k a

try :: Reporter k a -> Reporter k a

(<!>) :: Reporter k a -> Reporter k a -> Reporter k a

recover :: Reporter k a -> Reporter k a -> Reporter k a

chunk :: k -> Reporter k k

asChunk :: Reporter k () -> Reporter k k

char :: Char -> Reporter k Char

scan :: (Char -> Maybe a) -> Reporter k a

asciiByte :: Word8 -> Reporter k Word8

asciiScan :: (Word8 -> Maybe a) -> Reporter k a

Chunk k => Monad (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

(>>=) :: Reporter k a -> (a -> Reporter k b) -> Reporter k b

(>>) :: Reporter k a -> Reporter k b -> Reporter k b

return :: a -> Reporter k a

fail :: String -> Reporter k a

Chunk k => Functor (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

fmap :: (a -> b) -> Reporter k a -> Reporter k b

(<$) :: a -> Reporter k b -> Reporter k a

Chunk k => MonadFail (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

fail :: String -> Reporter k a

Chunk k => Applicative (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

pure :: a -> Reporter k a

(<*>) :: Reporter k (a -> b) -> Reporter k a -> Reporter k b

liftA2 :: (a -> b -> c) -> Reporter k a -> Reporter k b -> Reporter k c

(*>) :: Reporter k a -> Reporter k b -> Reporter k b

(<*) :: Reporter k a -> Reporter k b -> Reporter k a

Chunk k => Alternative (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

empty :: Reporter k a

(<|>) :: Reporter k a -> Reporter k a -> Reporter k a

some :: Reporter k a -> Reporter k [a]

many :: Reporter k a -> Reporter k [a]

Chunk k => MonadPlus (Reporter k)

Defined in Text.PariPari.Internal.Reporter

Methods

mzero :: Reporter k a

mplus :: Reporter k a -> Reporter k a -> Reporter k a

Chunk k => IsString (Reporter k k)

Defined in Text.PariPari.Internal.Reporter

Methods

fromString :: String -> Reporter k k

(Chunk k, Semigroup a) => Semigroup (Reporter k a)

Defined in Text.PariPari.Internal.Reporter

Methods

(<>) :: Reporter k a -> Reporter k a -> Reporter k a

sconcat :: NonEmpty (Reporter k a) -> Reporter k a

stimes :: Integral b => b -> Reporter k a -> Reporter k a

(Chunk k, Semigroup a, Monoid a) => Monoid (Reporter k a)

Defined in Text.PariPari.Internal.Reporter

Methods

mempty :: Reporter k a

mappend :: Reporter k a -> Reporter k a -> Reporter k a

mconcat :: [Reporter k a] -> Reporter k a

data Env k

Constructors

Env

Fields

• _envBuf :: !(Buffer k)
• _envFile :: !FilePath
• _envOptions :: !ReportOptions
• _envHidden :: !Bool
• _envContext :: ![String]
• _envRefLine :: Int#
• _envRefCol :: Int#

data State

Constructors

State

Fields

• _stOff :: Int#
• _stLine :: Int#
• _stCol :: Int#
• _stErrOff :: Int#
• _stErrLine :: Int#
• _stErrCol :: Int#
• _stErrors :: ![ErrorContext]
• _stReports :: ![Report]

local :: (State -> Env k -> Env k) -> Reporter k a -> Reporter k a

Reader monad, modify environment locally

get :: (Env k -> State -> a) -> Reporter k a

Reader monad, get something from the environment

raiseError :: Env k -> State -> (State -> b) -> Error -> b

mergeErrorState :: Env k -> State -> State -> State

Merge errors of two states, used when backtracking

data Report

Constructors

Report

Fields

• _reportFile :: !FilePath
• _reportErrors :: ![ErrorContext]
• _reportLine :: !Int
• _reportCol :: !Int

Instances

Eq Report

Defined in Text.PariPari.Internal.Reporter

Methods

(==) :: Report -> Report -> Bool

(/=) :: Report -> Report -> Bool

Show Report

Defined in Text.PariPari.Internal.Reporter

Methods

showsPrec :: Int -> Report -> ShowS

show :: Report -> String

showList :: [Report] -> ShowS

Generic Report

Defined in Text.PariPari.Internal.Reporter

Associated Types

type Rep Report :: Type -> Type

Methods

from :: Report -> Rep Report x

to :: Rep Report x -> Report

type Rep Report

Defined in Text.PariPari.Internal.Reporter

type Rep Report = D1 (MetaData "Report" "Text.PariPari.Internal.Reporter" "paripari-0.7.0.0-IvEurrnvmehFR9IQGtFHTg" False) (C1 (MetaCons "Report" PrefixI True) ((S1 (MetaSel (Just "_reportFile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FilePath) :*: S1 (MetaSel (Just "_reportErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [ErrorContext])) :*: (S1 (MetaSel (Just "_reportLine") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_reportCol") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int))))

runReporter :: Chunk k => Reporter k a -> FilePath -> k -> (Maybe a, [Report])

Run Reporter on the given chunk, returning the result if successful and reports from error recoveries. In the case of an error, Nothing is returned and the Report list is non-empty.

runReporterWithOptions :: Chunk k => ReportOptions -> Reporter k a -> FilePath -> k -> (Maybe a, [Report])

Run Reporter with additional ReportOptions.

data ErrorContext

Constructors

ErrorContext

Fields

• _ecErrors :: ![Error]
• _ecContext :: ![String]

Instances

Eq ErrorContext

Defined in Text.PariPari.Internal.Reporter

Methods

(==) :: ErrorContext -> ErrorContext -> Bool

(/=) :: ErrorContext -> ErrorContext -> Bool

Show ErrorContext

Defined in Text.PariPari.Internal.Reporter

Methods

showsPrec :: Int -> ErrorContext -> ShowS

show :: ErrorContext -> String

showList :: [ErrorContext] -> ShowS

Generic ErrorContext

Defined in Text.PariPari.Internal.Reporter

Associated Types

type Rep ErrorContext :: Type -> Type

Methods

from :: ErrorContext -> Rep ErrorContext x

to :: Rep ErrorContext x -> ErrorContext

type Rep ErrorContext

Defined in Text.PariPari.Internal.Reporter

type Rep ErrorContext = D1 (MetaData "ErrorContext" "Text.PariPari.Internal.Reporter" "paripari-0.7.0.0-IvEurrnvmehFR9IQGtFHTg" False) (C1 (MetaCons "ErrorContext" PrefixI True) (S1 (MetaSel (Just "_ecErrors") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [Error]) :*: S1 (MetaSel (Just "_ecContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 [String])))

showReport :: Report -> String

Pretty string representation of Report.

showErrors :: [ErrorContext] -> String

Pretty string representation of '[ErrorContext]'.

data ReportOptions

Constructors

ReportOptions

Fields

• _optMaxContexts :: !Int
• _optMaxErrorsPerContext :: !Int
• _optMaxLabelsPerContext :: !Int

Instances

Eq ReportOptions

Defined in Text.PariPari.Internal.Reporter

Methods

(==) :: ReportOptions -> ReportOptions -> Bool

(/=) :: ReportOptions -> ReportOptions -> Bool

Show ReportOptions

Defined in Text.PariPari.Internal.Reporter

Methods

showsPrec :: Int -> ReportOptions -> ShowS

show :: ReportOptions -> String

showList :: [ReportOptions] -> ShowS

Generic ReportOptions

Defined in Text.PariPari.Internal.Reporter

Associated Types

type Rep ReportOptions :: Type -> Type

Methods

from :: ReportOptions -> Rep ReportOptions x

to :: Rep ReportOptions x -> ReportOptions

type Rep ReportOptions

Defined in Text.PariPari.Internal.Reporter

type Rep ReportOptions = D1 (MetaData "ReportOptions" "Text.PariPari.Internal.Reporter" "paripari-0.7.0.0-IvEurrnvmehFR9IQGtFHTg" False) (C1 (MetaCons "ReportOptions" PrefixI True) (S1 (MetaSel (Just "_optMaxContexts") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int) :*: (S1 (MetaSel (Just "_optMaxErrorsPerContext") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_optMaxLabelsPerContext") SourceUnpack SourceStrict DecidedStrict) (Rec0 Int))))

defaultReportOptions :: ReportOptions