Prosidy.Compile.Run

Documentation

data RunError

Errors that may be returned from the interpreter.

Constructors

Group Location (Set RunError)

Groups a set of errors with a location for more helpful error messages.

MatchError Text

Expected a different type. Thrown on failed matches of sum types.

ParseError Key String

The provided parser failed to parse a setting.

RequiredSetting Key

A setting was required, but not found on a node.

TooFewElements

Expected more elements when matching sequentially.

TooManyElements

Expected fewer elements when matching sequentially.

UnexpectedProperties (HashSet Key) (HashSet Key)

A property was found on a node, but not mentioned in its specification.

UnexpectedSettings (HashSet Key) (HashSet Key)

A setting was found on a node, but not mentioned in its specification.

Instances

Eq RunError

Defined in Prosidy.Compile.Run

Methods

(==) :: RunError -> RunError -> Bool

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

Ord RunError

Defined in Prosidy.Compile.Run

Methods

compare :: RunError -> RunError -> Ordering

(<) :: RunError -> RunError -> Bool

(<=) :: RunError -> RunError -> Bool

(>) :: RunError -> RunError -> Bool

(>=) :: RunError -> RunError -> Bool

max :: RunError -> RunError -> RunError

min :: RunError -> RunError -> RunError

Show RunError

Defined in Prosidy.Compile.Run

Methods

showsPrec :: Int -> RunError -> ShowS

show :: RunError -> String

showList :: [RunError] -> ShowS

Exception RunError

Defined in Prosidy.Compile.Run

Methods

toException :: RunError -> SomeException

fromException :: SomeException -> Maybe RunError

displayException :: RunError -> String

Pretty RunError

Defined in Prosidy.Compile.Run

Methods

pretty :: RunError -> Doc ann

prettyList :: [RunError] -> Doc ann

newtype RunErrors

A newtype wrapper over a set of RunErrors.

This is defined to allow an instances of Exception and Pretty for error sets.

Constructors

RunErrors (Set RunError)

Instances

Eq RunErrors

Defined in Prosidy.Compile.Run

Methods

(==) :: RunErrors -> RunErrors -> Bool

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

Ord RunErrors

Defined in Prosidy.Compile.Run

Methods

compare :: RunErrors -> RunErrors -> Ordering

(<) :: RunErrors -> RunErrors -> Bool

(<=) :: RunErrors -> RunErrors -> Bool

(>) :: RunErrors -> RunErrors -> Bool

(>=) :: RunErrors -> RunErrors -> Bool

max :: RunErrors -> RunErrors -> RunErrors

min :: RunErrors -> RunErrors -> RunErrors

Show RunErrors

Defined in Prosidy.Compile.Run

Methods

showsPrec :: Int -> RunErrors -> ShowS

show :: RunErrors -> String

showList :: [RunErrors] -> ShowS

Semigroup RunErrors

Defined in Prosidy.Compile.Run

Methods

(<>) :: RunErrors -> RunErrors -> RunErrors

sconcat :: NonEmpty RunErrors -> RunErrors

stimes :: Integral b => b -> RunErrors -> RunErrors

Monoid RunErrors

Defined in Prosidy.Compile.Run

Methods

mempty :: RunErrors

mappend :: RunErrors -> RunErrors -> RunErrors

mconcat :: [RunErrors] -> RunErrors

Exception RunErrors

Defined in Prosidy.Compile.Run

Methods

toException :: RunErrors -> SomeException

fromException :: SomeException -> Maybe RunErrors

displayException :: RunErrors -> String

Pretty RunErrors

Defined in Prosidy.Compile.Run

Methods

pretty :: RunErrors -> Doc ann

prettyList :: [RunErrors] -> Doc ann

data RunT f t a

An interpreter over Rules.

Instances

Functor f => Strong (RunT f)

Defined in Prosidy.Compile.Run

Methods

first' :: RunT f a b -> RunT f (a, c) (b, c)

second' :: RunT f a b -> RunT f (c, a) (c, b)

Functor f => Profunctor (RunT f)

Defined in Prosidy.Compile.Run

Methods

dimap :: (a -> b) -> (c -> d) -> RunT f b c -> RunT f a d

lmap :: (a -> b) -> RunT f b c -> RunT f a c

rmap :: (b -> c) -> RunT f a b -> RunT f a c

(#.) :: forall a b c q. Coercible c b => q b c -> RunT f a b -> RunT f a c

(.#) :: forall a b c q. Coercible b a => RunT f b c -> q a b -> RunT f a c

Applicative f => Context (RunT f)

Defined in Prosidy.Compile.Run

Associated Types

type Local (RunT f) :: Type -> Type

Methods

runSelf :: RunT f i i

liftRule :: Local (RunT f) a -> RunT f i a

Applicative f => Interpret (RunT f) Text

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor Text (Local (RunT f)) a -> RunT f Text a

Applicative f => Interpret (RunT f) Paragraph

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor Paragraph (Local (RunT f)) a -> RunT f Paragraph a

Applicative f => Interpret (RunT f) Metadata

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor Metadata (Local (RunT f)) a -> RunT f Metadata a

Applicative f => Interpret (RunT f) Inline

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor Inline (Local (RunT f)) a -> RunT f Inline a

Applicative f => Interpret (RunT f) Fragment

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor Fragment (Local (RunT f)) a -> RunT f Fragment a

Applicative f => Interpret (RunT f) Document

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor Document (Local (RunT f)) a -> RunT f Document a

Applicative f => Interpret (RunT f) Block

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor Block (Local (RunT f)) a -> RunT f Block a

(Applicative f, Interpret (RunT f) t) => Interpret (RunT f) (SeriesNE t)

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor (SeriesNE t) (Local (RunT f)) a -> RunT f (SeriesNE t) a

(Applicative f, Interpret (RunT f) t) => Interpret (RunT f) (Series t)

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor (Series t) (Local (RunT f)) a -> RunT f (Series t) a

(Applicative f, Interpret (RunT f) t) => Interpret (RunT f) (Tag t)

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor (Tag t) (Local (RunT f)) a -> RunT f (Tag t) a

(Applicative f, Interpret (RunT f) t) => Interpret (RunT f) (Region t)

Defined in Prosidy.Compile.Run

Methods

runRule :: RuleFor (Region t) (Local (RunT f)) a -> RunT f (Region t) a

Functor f => Functor (RunT f t)

Defined in Prosidy.Compile.Run

Methods

fmap :: (a -> b) -> RunT f t a -> RunT f t b

(<$) :: a -> RunT f t b -> RunT f t a

Applicative f => Applicative (RunT f t)

Defined in Prosidy.Compile.Run

Methods

pure :: a -> RunT f t a

(<*>) :: RunT f t (a -> b) -> RunT f t a -> RunT f t b

liftA2 :: (a -> b -> c) -> RunT f t a -> RunT f t b -> RunT f t c

(*>) :: RunT f t a -> RunT f t b -> RunT f t b

(<*) :: RunT f t a -> RunT f t b -> RunT f t a

Applicative f => Alternative (RunT f t)

Defined in Prosidy.Compile.Run

Methods

empty :: RunT f t a

(<|>) :: RunT f t a -> RunT f t a -> RunT f t a

some :: RunT f t a -> RunT f t [a]

many :: RunT f t a -> RunT f t [a]

type Local (RunT f)

Defined in Prosidy.Compile.Run

type Local (RunT f) = f

type Run = RunT Identity

RunT specialized to Identity.

run :: i -> Run i a -> Either RunErrors a

Run a Run interpreter to completion.

runT :: i -> RunT f i a -> Either RunErrors (f a)

Run a RunT interpreter to completion.