Prosidy.Compile.Core

Documentation

data RuleF input error context output where

The control functor for compiling Prosidy elements. Each action corresponds to an action to perform on the input variable.

See RuleT and Rule for use of this type.

Constructors

Fail :: Error error -> RuleF input error context output

Throw an error.

Lift :: (input -> context (Either (Error error) output)) -> RuleF input error context output

Embed a raw action as a rule. Note: Please avoid using this if possible: it breaks static introspection!

TestMatch :: CanMatch input => NonEmpty (Pattern input error context output) -> RuleF input error context output

Given a non-empty list of potential cases, construct a Rule that processes any items matching at least one of those cases.

Traverse :: Traversable t => (input -> t i) -> (t o -> output) -> RuleT i error context o -> RuleF input error context output

GetContent :: HasContent input => RuleT (Content input) error context output -> RuleF input error context output

When input is a value wrapping some Content, enable access to that Content by wrapping a RuleT.

GetProperty :: HasMetadata input => (Bool -> a) -> Key -> RuleF input error context a

Fetch a property from items with metadata.

GetSetting :: HasMetadata input => (Maybe x -> output) -> Key -> (Text -> Either String x) -> RuleF input error context output

Fetch an optional setting from items with metadata.

GetRequiredSetting :: HasMetadata input => Key -> (Text -> Either String output) -> RuleF input error context output

Fetch a required setting from items with metadata.

GetSelf :: (input -> output) -> RuleF input error context output

Get the raw text from a Text node.

Instances

Functor context => Functor (RuleF input error context)

Defined in Prosidy.Compile.Core

Methods

fmap :: (a -> b) -> RuleF input error context a -> RuleF input error context b

(<$) :: a -> RuleF input error context b -> RuleF input error context a

data RuleT input error context output

A single compilation rule. Parameterized by the following types:

• input: The type of the Prosidy node that is currently accessible.
• error: Allows users to specify a custom error type to be used for throwing errors. Void can be used to rely solely on the errors built into this library.
• context: A Monad for performing contextual computation beyond what is provided by this library. If additional contextual computation is not desired, use Identity as the type.
• output: The resulting output type.

Instances

MonadTrans (RuleT input error)

Defined in Prosidy.Compile.Core

Methods

lift :: Monad m => m a -> RuleT input error m a

Functor (RuleT input error context)

Defined in Prosidy.Compile.Core

Methods

fmap :: (a -> b) -> RuleT input error context a -> RuleT input error context b

(<$) :: a -> RuleT input error context b -> RuleT input error context a

Applicative (RuleT input error context)

Defined in Prosidy.Compile.Core

Methods

pure :: a -> RuleT input error context a

(<*>) :: RuleT input error context (a -> b) -> RuleT input error context a -> RuleT input error context b

liftA2 :: (a -> b -> c) -> RuleT input error context a -> RuleT input error context b -> RuleT input error context c

(*>) :: RuleT input error context a -> RuleT input error context b -> RuleT input error context b

(<*) :: RuleT input error context a -> RuleT input error context b -> RuleT input error context a

type Rule input error = RuleT input error Identity

RuleT without a contextual environment.

class (forall i e. Functor (Pattern t i e), HasLocation t) => CanMatch t where

A (lawless) typeclass for enabling fallible matching on nodes.

Implementing new instances of this class in library code is *unneccessary* and *unsupported*.

Methods

evalPattern

Arguments

:: Applicative g

=> Pattern t error context output

The Pattern to match against

-> Interpret error context g

An interpreter for evaluating the match.

-> t

The value to attempt to match against

-> Either (NoMatch t) (g output)

Attempt to match a pattern against a value.

noMatchError :: NoMatch t -> Error e

Lift a NoMatch error into the Error type.

Instances

CanMatch Block

Defined in Prosidy.Compile.Core

Associated Types

data Pattern Block :: Type -> (Type -> Type) -> Type -> Type

data NoMatch Block

Methods

evalPattern :: forall g error (context :: Type -> Type) output. Applicative g => Pattern Block error context output -> Interpret error context g -> Block -> Either (NoMatch Block) (g output)

noMatchError :: NoMatch Block -> Error e

CanMatch Inline

Defined in Prosidy.Compile.Core

Associated Types

data Pattern Inline :: Type -> (Type -> Type) -> Type -> Type

data NoMatch Inline

Methods

evalPattern :: forall g error (context :: Type -> Type) output. Applicative g => Pattern Inline error context output -> Interpret error context g -> Inline -> Either (NoMatch Inline) (g output)

noMatchError :: NoMatch Inline -> Error e

type Interpret e f g = forall i a. i -> RuleF i e f a -> g a

Runs a single RuleF into an applicative g. Passing this value to interpretWith will fully evaluate a RuleT into the same functor.

type BlockRegion = Region (Series Block)

A BlockTag with the tag name removed.

type InlineRegion = Region (Series Inline)

An InlineTag with the tag name removed.

type LiteralRegion = Region Text

A LiteralTag with the tag name removed.

interpretWith :: Applicative g => RuleT i e f a -> Interpret e f g -> i -> g a

Build an interpreter into a functor g.

evalPatterns :: (CanMatch i, IsError e, MonadErrors e g) => NonEmpty (Pattern i e f o) -> Interpret e f g -> i -> g o

Match one or more patterns, in sequence, against a value. The result from the first successful pattern will be returned. Subsequent matches will not be tried.

rule :: RuleF i e f o -> RuleT i e f o

Lifts a RuleF into a RuleT.