Safe Haskell	None
Language	Haskell2010

Text.PariPari.Internal.Reporter

Synopsis

newtype Reporter k a = Reporter {
- unReporter :: forall b. Env k -> State -> (a -> State -> b) -> (State -> b) -> b
}
data Env k = Env {
- _envBuf :: !(Buffer k)
- _envEnd :: !Int
- _envFile :: !FilePath
- _envOptions :: !ReportOptions
- _envHidden :: !Bool
- _envCommit :: !Int
- _envContext :: [String]
- _envRefLine :: !Int
- _envRefCol :: !Int
}
data State = State {
- _stOff :: !Int
- _stLine :: !Int
- _stCol :: !Int
- _stErrOff :: !Int
- _stErrLine :: !Int
- _stErrCol :: !Int
- _stErrCommit :: !Int
- _stErrors :: [ErrorContext]
}
local :: (State -> Env k -> Env k) -> Reporter k a -> Reporter k a
get :: (Env k -> State -> a) -> Reporter k a
raiseError :: Env k -> State -> (State -> b) -> Error -> b
mergeErrorState :: Env k -> State -> State -> State
data Report = Report {
- _reportFile :: !FilePath
- _reportLine :: !Int
- _reportCol :: !Int
- _reportErrors :: [ErrorContext]
}
runReporter :: Chunk k => Reporter k a -> FilePath -> k -> Either Report a
runReporterWithOptions :: Chunk k => ReportOptions -> Reporter k a -> FilePath -> k -> Either Report a
data ErrorContext = ErrorContext {
- _ecErrors :: [Error]
- _ecContext :: [String]
}
showReport :: Report -> String
showErrors :: [ErrorContext] -> String
data ReportOptions = ReportOptions {
- _optMaxContexts :: !Int
- _optMaxErrorsPerContext :: !Int
- _optMaxLabelsPerContext :: !Int
}
defaultReportOptions :: ReportOptions

Documentation

newtype Reporter k a Source #

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

CharChunk k => CharParser k (Reporter k) Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods char :: Char -> Reporter k Char Source # scan :: (Char -> Maybe a) -> Reporter k a Source # asciiByte :: Word8 -> Reporter k Word8 Source # asciiSatisfy :: (Word8 -> Bool) -> Reporter k Word8 Source #
Chunk k => ChunkParser k (Reporter k) Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods getFile :: Reporter k FilePath Source # getPos :: Reporter k Pos Source # getRefPos :: Reporter k Pos Source # withRefPos :: Reporter k a -> Reporter k a Source # notFollowedBy :: Show a => Reporter k a -> Reporter k () Source # lookAhead :: Reporter k a -> Reporter k a Source # failWith :: Error -> Reporter k a Source # eof :: Reporter k () Source # label :: String -> Reporter k a -> Reporter k a Source # hidden :: Reporter k a -> Reporter k a Source # commit :: Reporter k a -> Reporter k a Source # element :: Element k -> Reporter k (Element k) Source # elementScan :: (Element k -> Maybe a) -> Reporter k a Source # chunk :: k -> Reporter k k Source # asChunk :: Reporter k () -> Reporter k k Source #
Chunk k => Monad (Reporter k) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods fail :: String -> Reporter k a #
Chunk k => Applicative (Reporter k) Source #
Instance details 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) Source #
Instance details 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) Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods mzero :: Reporter k a # mplus :: Reporter k a -> Reporter k a -> Reporter k a #
CharChunk k => IsString (Reporter k k) Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods fromString :: String -> Reporter k k #
(Chunk k, Semigroup a) => Semigroup (Reporter k a) Source #
Instance details 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, Monoid a) => Monoid (Reporter k a) Source #
Instance details 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 Source #

Constructors

Env
Fields _envBuf :: !(Buffer k) _envEnd :: !Int _envFile :: !FilePath _envOptions :: !ReportOptions _envHidden :: !Bool _envCommit :: !Int _envContext :: [String] _envRefLine :: !Int _envRefCol :: !Int

data State Source #

Constructors

State
Fields _stOff :: !Int _stLine :: !Int _stCol :: !Int _stErrOff :: !Int _stErrLine :: !Int _stErrCol :: !Int _stErrCommit :: !Int _stErrors :: [ErrorContext]

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

Reader monad, modify environment locally

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

Reader monad, get something from the environment

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

mergeErrorState :: Env k -> State -> State -> State Source #

Merge errors of two states, used when backtracking

data Report Source #

Constructors

Report
Fields _reportFile :: !FilePath _reportLine :: !Int _reportCol :: !Int _reportErrors :: [ErrorContext]

Instances

Eq Report Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods (==) :: Report -> Report -> Bool # (/=) :: Report -> Report -> Bool #
Show Report Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods showsPrec :: Int -> Report -> ShowS # show :: Report -> String # showList :: [Report] -> ShowS #
Generic Report Source #
Instance details Defined in Text.PariPari.Internal.Reporter Associated Types type Rep Report :: * -> * # Methods from :: Report -> Rep Report x # to :: Rep Report x -> Report #
type Rep Report Source #
Instance details Defined in Text.PariPari.Internal.Reporter type Rep Report = D1 (MetaData "Report" "Text.PariPari.Internal.Reporter" "paripari-0.3.0.0-9PfmBeBgqLnEDWGUOlcW2v" False) (C1 (MetaCons "Report" PrefixI True) ((S1 (MetaSel (Just "_reportFile") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 FilePath) :: S1 (MetaSel (Just "_reportLine") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int)) :: (S1 (MetaSel (Just "_reportCol") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :*: S1 (MetaSel (Just "_reportErrors") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ErrorContext]))))

runReporter :: Chunk k => Reporter k a -> FilePath -> k -> Either Report a Source #

Run Reporter on the given chunk, returning either an error Report or, if successful, the result.

runReporterWithOptions :: Chunk k => ReportOptions -> Reporter k a -> FilePath -> k -> Either Report a Source #

Run Reporter with additional ReportOptions.

data ErrorContext Source #

Constructors

ErrorContext
Fields _ecErrors :: [Error] _ecContext :: [String]

Instances

Eq ErrorContext Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods (==) :: ErrorContext -> ErrorContext -> Bool # (/=) :: ErrorContext -> ErrorContext -> Bool #
Show ErrorContext Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods showsPrec :: Int -> ErrorContext -> ShowS # show :: ErrorContext -> String # showList :: [ErrorContext] -> ShowS #
Generic ErrorContext Source #
Instance details Defined in Text.PariPari.Internal.Reporter Associated Types type Rep ErrorContext :: * -> * # Methods from :: ErrorContext -> Rep ErrorContext x # to :: Rep ErrorContext x -> ErrorContext #
type Rep ErrorContext Source #
Instance details Defined in Text.PariPari.Internal.Reporter type Rep ErrorContext = D1 (MetaData "ErrorContext" "Text.PariPari.Internal.Reporter" "paripari-0.3.0.0-9PfmBeBgqLnEDWGUOlcW2v" False) (C1 (MetaCons "ErrorContext" PrefixI True) (S1 (MetaSel (Just "_ecErrors") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Error]) :*: S1 (MetaSel (Just "_ecContext") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String])))

showReport :: Report -> String Source #

Pretty string representation of Report.

showErrors :: [ErrorContext] -> String Source #

Pretty string representation of '[ErrorContext]'.

data ReportOptions Source #

Constructors

ReportOptions
Fields _optMaxContexts :: !Int _optMaxErrorsPerContext :: !Int _optMaxLabelsPerContext :: !Int

Instances

Eq ReportOptions Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods (==) :: ReportOptions -> ReportOptions -> Bool # (/=) :: ReportOptions -> ReportOptions -> Bool #
Show ReportOptions Source #
Instance details Defined in Text.PariPari.Internal.Reporter Methods showsPrec :: Int -> ReportOptions -> ShowS # show :: ReportOptions -> String # showList :: [ReportOptions] -> ShowS #
Generic ReportOptions Source #
Instance details Defined in Text.PariPari.Internal.Reporter Associated Types type Rep ReportOptions :: * -> * # Methods from :: ReportOptions -> Rep ReportOptions x # to :: Rep ReportOptions x -> ReportOptions #
type Rep ReportOptions Source #
Instance details Defined in Text.PariPari.Internal.Reporter type Rep ReportOptions = D1 (MetaData "ReportOptions" "Text.PariPari.Internal.Reporter" "paripari-0.3.0.0-9PfmBeBgqLnEDWGUOlcW2v" False) (C1 (MetaCons "ReportOptions" PrefixI True) (S1 (MetaSel (Just "_optMaxContexts") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: (S1 (MetaSel (Just "_optMaxErrorsPerContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int) :: S1 (MetaSel (Just "_optMaxLabelsPerContext") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Int))))

defaultReportOptions :: ReportOptions Source #