Prosidy.Compile.DSL

Documentation

content :: RegionLike t => Rules (Content t) f a -> Rules t f a

Access the inner content of the RegionLike value t.

Series rules

(&>) :: Rules t f a -> Rules (Series t) f (Series a) -> Rules (Series t) f (Series a) infixr 3

Given a Series, perform the rule on the left hand side on the first element of the Series, and the rule on the right hand side on all items after the first.

This can be used to define rules which must be evaluated sequentially.

(&>>) :: Rules t f a -> Rules (Series t) f (Series a) -> Rules (SeriesNE t) f (SeriesNE a) infixr 1

Like (&>), but returns a combined rule which operates on a non-empty series (SeriesNE).

folded :: Monoid a => Rules t f a -> Rules (Series t) f a

Lift a rule to operate on a Series by folding the results of evaluation against each element into a single result.

folded1 :: Monoid a => Rules t f a -> Rules (SeriesNE t) f a

Like folded, but operates on a non-empty series.

collect :: Rules t f a -> Rules (Series t) f (Series a)

Lift a rule to collect many of that rule in series

end :: Rules (Series t) f (Series a)

Match the end of a Series.

endWith :: a -> Rules (Series t) f a

Match the end of a Series, returning the provided value.

Metadata rules

prop :: RegionLike t => Key -> Rules t f Bool

Check if a Metadata property is set on a node.

req :: forall a t f. (RegionLike t, FromSetting a) => Key -> Rules t f a

Fetch a required Metadata setting from a node.

opt :: forall a t f. (RegionLike t, FromSetting a) => Key -> Rules t f (Maybe a)

Fetch an optional Metadata setting from a node.

lax :: RegionLike t => Rules t f ()

Allow unknown properties and settings in this region.

Matchers

type Match t f a = MatchM t f a ()

A type used to declare alternatives in do notation.

match :: Match t f a -> Rules t f a

Lifts a Match into Rules by trying each defined pattern, from top to bottom, until a match is found.

blockTag :: Functor f => Key -> Rules BlockRegion f a -> Match Block f a

Match a BlockTag with the proided Key.

inlineTag :: Functor f => Key -> Rules InlineRegion f a -> Match Inline f a

Match a InlineTag with the provided Key.

literalTag :: Functor f => Key -> Rules LiteralRegion f a -> Match Block f a

Match a LiteralTag with the provided Key.

paragraph :: Rules (SeriesNE Inline) f a -> Match Block f a

Match a paragraph which is not enclosed in a tag.

text :: (Text -> a) -> Match Inline f a

Match textual content, transforming it with the provided function.

breakWith :: a -> Match Inline f a

Replace inline breaks with the provided vlaue.

Get wild with actions

local :: Functor f => f a -> Rules t f a

Lift a contextual item into Rules.

self :: Rules t f t

Get the currently focused node as a value.

hoist :: HoistRuleFor t => (forall b. f b -> g b) -> Rules t f a -> Rules t g a

Map over the contextual functor f in Rules.

Convenience classes

class FromSetting a where

A class for values which can be parsed from Text.

Minimal complete definition

Nothing

Methods

parseSetting :: Text -> Either String a

default parseSetting :: (Typeable a, Read a) => Text -> Either String a

Instances

FromSetting Double

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text -> Either String Double

FromSetting Float

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text -> Either String Float

FromSetting Int

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text -> Either String Int

FromSetting Integer

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text -> Either String Integer

FromSetting Natural

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text -> Either String Natural

FromSetting Word

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text -> Either String Word

FromSetting String

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text -> Either String String

FromSetting Text

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text -> Either String Text

FromSetting Text

Defined in Prosidy.Compile.DSL

Methods

parseSetting :: Text0 -> Either String Text

class HasContent t => RegionLike t

A class for recursive nodes in a document.

Minimal complete definition

liftRegionRule

Instances

RegionLike Document

Defined in Prosidy.Compile.DSL

Methods

liftRegionRule :: forall (f :: Type -> Type) a. RegionRule (Content Document) f a -> RuleFor Document f a

RegionLike (Region t)

Defined in Prosidy.Compile.DSL

Methods

liftRegionRule :: forall (f :: Type -> Type) a. RegionRule (Content (Region t)) f a -> RuleFor (Region t) f a

RegionLike (Tag t)

Defined in Prosidy.Compile.DSL

Methods

liftRegionRule :: forall (f :: Type -> Type) a. RegionRule (Content (Tag t)) f a -> RuleFor (Tag t) f a