Hakyllbars.Context

Documentation

newtype Context a

Constructors

Context

Fields

• unContext :: ContextFunction a

Instances

Monoid (Context a)

Defined in Hakyllbars.Context

Methods

mempty :: Context a

mappend :: Context a -> Context a -> Context a

mconcat :: [Context a] -> Context a

Semigroup (Context a)

Defined in Hakyllbars.Context

Methods

(<>) :: Context a -> Context a -> Context a

sconcat :: NonEmpty (Context a) -> Context a

stimes :: Integral b => b -> Context a -> Context a

FromValue (Context a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (Context a)

IntoContext (Context a) a

Defined in Hakyllbars.Context

Methods

intoContext :: Context a -> Context a

IntoValue (Context a) a

Defined in Hakyllbars.Context

Methods

intoValue :: Context a -> ContextValue a

type ContextFunction a = String -> TemplateRunner a (ContextValue a)

getContext :: Identifier -> Compiler (Context a)

itemFilePath :: Item a -> FilePath

data TemplateState a

Constructors

TemplateState

Fields

• tplContextStack :: [(Context a, Context a)]
• tplItemStack :: [Item a]
• tplCallStack :: [String]

Instances

IntoValue (TemplateRunner a (ContextValue a)) a

Defined in Hakyllbars.Context

Methods

intoValue :: TemplateRunner a (ContextValue a) -> ContextValue a

(IntoValue v a, FromValue w a) => FromValue (FunctionValue v w a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (FunctionValue v w a)

(FromValue v a, IntoValue w a) => IntoValue (FunctionValue v w a) a

Defined in Hakyllbars.Context

Methods

intoValue :: FunctionValue v w a -> ContextValue a

(IntoValue v a, IntoValue x a, FromValue w a) => FromValue (FunctionValue2 v x w a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (FunctionValue2 v x w a)

(FromValue v a, FromValue x a, IntoValue w a) => IntoValue (FunctionValue2 v x w a) a

Defined in Hakyllbars.Context

Methods

intoValue :: FunctionValue2 v x w a -> ContextValue a

(IntoValue v a, IntoValue x a, IntoValue y a, FromValue w a) => FromValue (FunctionValue3 v x y w a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (FunctionValue3 v x y w a)

(FromValue v a, FromValue x a, FromValue y a, IntoValue w a) => IntoValue (FunctionValue3 v x y w a) a

Defined in Hakyllbars.Context

Methods

intoValue :: FunctionValue3 v x y w a -> ContextValue a

(IntoValue v a, IntoValue x a, IntoValue y a, IntoValue z a, FromValue w a) => FromValue (FunctionValue4 v x y z w a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (FunctionValue4 v x y z w a)

(FromValue v a, FromValue x a, FromValue y a, FromValue z a, IntoValue w a) => IntoValue (FunctionValue4 v x y z w a) a

Defined in Hakyllbars.Context

Methods

intoValue :: FunctionValue4 v x y z w a -> ContextValue a

type TemplateRunner a b = StateT (TemplateState a) Compiler b

tplItem :: TemplateRunner a (Item a)

tplModifyItem :: (Item a -> TemplateRunner a (Item a)) -> TemplateRunner a ()

tplReplaceItem :: Item a -> TemplateRunner a ()

tplPopItem :: TemplateRunner a (Item a)

tplPopBody :: TemplateRunner a a

tplPushItem :: Item a -> TemplateRunner a ()

tplWithItem :: Item a -> TemplateRunner a b -> TemplateRunner a b

tplContext :: TemplateRunner a (Context a)

tplPushContext :: Context a -> TemplateRunner a ()

tplPopContext :: TemplateRunner a (Context a)

tplWithContext :: Context a -> TemplateRunner a b -> TemplateRunner a b

Place context within a given scope.

tplGet :: FromValue v a => String -> TemplateRunner a v

Get a value from the context by name and convert it.

tplGetWithItemContext :: FromValue v a => Item a -> Context a -> String -> TemplateRunner a v

Get a value from a specific item's context by name and convert it.

tplPut :: Context a -> TemplateRunner a ()

Place context in global scope.

tplWithCall :: String -> TemplateRunner a b -> TemplateRunner a b

Perform an action within the scope of a call.

tplWithPos :: (x -> SourcePos) -> (x -> TemplateRunner a b) -> x -> TemplateRunner a b

tplWithField :: String -> TemplateRunner a b -> TemplateRunner a b

Perform an action within the scope of a field call.

tplFail :: String -> TemplateRunner a b

Fail with an error message and trace.

tplTried :: String -> TemplateRunner a b

Fail with a no-result message and trace.

tplTrace :: TemplateRunner a [String]

Return the current call stack, with the most recent call first.

tplTraced :: String -> TemplateRunner a String

Get a formatted trace message with the most recent call first.

field :: IntoValue v a => String -> (Item a -> TemplateRunner a v) -> Context a

Apply f to an item if key is requested.

missingField :: Context a

Reports missing field.

constField :: IntoValue v a => String -> v -> Context a

Const-valued field, returns the same val per key.

itemsField :: String -> Context a -> [Item a] -> Context a

Creates a field containing a list of items.

mapField :: (FromValue v a, IntoValue w a) => (v -> w) -> Context a -> Context a

Mapping of function g after context f.

bindField :: (FromValue v a, IntoValue w a) => (v -> TemplateRunner a w) -> Context a -> Context a

Binding of function g after context f.

composeField :: Context a -> Context a -> Context a

Alternation of context g after context f.

hashMapField :: IntoValue v a => HashMap String v -> Context a

Lookup of val by key into provided HashMap.

forItemField :: IntoValue v a => String -> [Identifier] -> (Item a -> TemplateRunner a v) -> Context a

functionField :: (FromValue v a, IntoValue w a) => String -> (v -> TemplateRunner a w) -> Context a

functionField2 :: (FromValue v a, FromValue x a, IntoValue w a) => String -> (v -> x -> TemplateRunner a w) -> Context a

functionField3 :: (FromValue v a, FromValue x a, FromValue y a, IntoValue w a) => String -> (v -> x -> y -> TemplateRunner a w) -> Context a

functionField4 :: (FromValue v a, FromValue x a, FromValue y a, FromValue z a, IntoValue w a) => String -> (v -> x -> y -> z -> TemplateRunner a w) -> Context a

class IntoContext v a where

Methods

intoContext :: v -> Context a

Instances

IntoContext Object a

Defined in Hakyllbars.Context

Methods

intoContext :: Object -> Context a

IntoContext (Context a) a

Defined in Hakyllbars.Context

Methods

intoContext :: Context a -> Context a

IntoValue v a => IntoContext [(String, v)] a

Defined in Hakyllbars.Context

Methods

intoContext :: [(String, v)] -> Context a

IntoValue v a => IntoContext (HashMap String v) a

Defined in Hakyllbars.Context

Methods

intoContext :: HashMap String v -> Context a

data ContextValue a

ContextValues can hold certain types of data within a context.

Constructors

EmptyValue

UndefinedValue String (Item a) [String] [String]

ContextValue (Context a)

ListValue [ContextValue a]

BoolValue Bool

StringValue String

DoubleValue Double

IntValue Int

FunctionValue (ContextValue a -> TemplateRunner a (ContextValue a))

BlockValue Block

ItemValue (Item a)

ThunkValue (TemplateRunner a (ContextValue a))

PairValue (ContextValue a, ContextValue a)

Instances

Show (ContextValue a)

Defined in Hakyllbars.Context

Methods

showsPrec :: Int -> ContextValue a -> ShowS

show :: ContextValue a -> String

showList :: [ContextValue a] -> ShowS

FromValue (ContextValue a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (ContextValue a)

IntoValue (ContextValue a) a

Defined in Hakyllbars.Context

Methods

intoValue :: ContextValue a -> ContextValue a

IntoValue (TemplateRunner a (ContextValue a)) a

Defined in Hakyllbars.Context

Methods

intoValue :: TemplateRunner a (ContextValue a) -> ContextValue a

type FunctionValue v w a = v -> TemplateRunner a w

type FunctionValue2 v x w a = v -> FunctionValue x w a

type FunctionValue3 v x y w a = v -> FunctionValue2 x y w a

type FunctionValue4 v x y z w a = v -> FunctionValue3 x y z w a

itemValue :: Context a -> Item a -> ContextValue a

class IntoValue' (flag :: Bool) v a where

Methods

intoValue' :: Proxy flag -> v -> ContextValue a

Instances

IntoValue' 'True String a

Defined in Hakyllbars.Context

Methods

intoValue' :: Proxy 'True -> String -> ContextValue a

IntoValue v a => IntoValue' 'False [v] a

Defined in Hakyllbars.Context

Methods

intoValue' :: Proxy 'False -> [v] -> ContextValue a

type family FString a :: Bool where ...

Equations

FString Char = 'True

FString _ = 'False

class IntoValue v a where

Inject a concrete type v into a ContextValue a.

Methods

intoValue :: v -> ContextValue a

Instances

IntoValue Value a

Defined in Hakyllbars.Context

Methods

intoValue :: Value -> ContextValue a

IntoValue Block a

Defined in Hakyllbars.Context

Methods

intoValue :: Block -> ContextValue a

IntoValue () a

Defined in Hakyllbars.Context

Methods

intoValue :: () -> ContextValue a

IntoValue Bool a

Defined in Hakyllbars.Context

Methods

intoValue :: Bool -> ContextValue a

IntoValue Double a

Defined in Hakyllbars.Context

Methods

intoValue :: Double -> ContextValue a

IntoValue Int a

Defined in Hakyllbars.Context

Methods

intoValue :: Int -> ContextValue a

IntoValue (Item a) a

Defined in Hakyllbars.Context

Methods

intoValue :: Item a -> ContextValue a

IntoValue (Context a) a

Defined in Hakyllbars.Context

Methods

intoValue :: Context a -> ContextValue a

IntoValue (ContextValue a) a

Defined in Hakyllbars.Context

Methods

intoValue :: ContextValue a -> ContextValue a

IntoValue v a => IntoValue (Maybe v) a

Defined in Hakyllbars.Context

Methods

intoValue :: Maybe v -> ContextValue a

(FString v ~ flag, IntoValue' flag [v] a) => IntoValue [v] a

Defined in Hakyllbars.Context

Methods

intoValue :: [v] -> ContextValue a

IntoValue (TemplateRunner a (ContextValue a)) a

Defined in Hakyllbars.Context

Methods

intoValue :: TemplateRunner a (ContextValue a) -> ContextValue a

(IntoValue v a, IntoValue x a) => IntoValue (v, x) a

Defined in Hakyllbars.Context

Methods

intoValue :: (v, x) -> ContextValue a

(FromValue v a, IntoValue w a) => IntoValue (FunctionValue v w a) a

Defined in Hakyllbars.Context

Methods

intoValue :: FunctionValue v w a -> ContextValue a

(FromValue v a, FromValue x a, IntoValue w a) => IntoValue (FunctionValue2 v x w a) a

Defined in Hakyllbars.Context

Methods

intoValue :: FunctionValue2 v x w a -> ContextValue a

(FromValue v a, FromValue x a, FromValue y a, IntoValue w a) => IntoValue (FunctionValue3 v x y w a) a

Defined in Hakyllbars.Context

Methods

intoValue :: FunctionValue3 v x y w a -> ContextValue a

(FromValue v a, FromValue x a, FromValue y a, FromValue z a, IntoValue w a) => IntoValue (FunctionValue4 v x y z w a) a

Defined in Hakyllbars.Context

Methods

intoValue :: FunctionValue4 v x y z w a -> ContextValue a

class FromValue v a where

Extract a concrete value of type v from a ContextValue a.

Methods

fromValue :: ContextValue a -> TemplateRunner a v

Instances

FromValue Block a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a Block

FromValue Bool a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a Bool

FromValue Double a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a Double

FromValue Int a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a Int

FromValue (Item a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (Item a)

FromValue (Context a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (Context a)

FromValue (ContextValue a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (ContextValue a)

(FString v ~ flag, FromValue' flag [v] a) => FromValue [v] a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a [v]

(FromValue v a, FromValue x a) => FromValue (v, x) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (v, x)

(IntoValue v a, FromValue w a) => FromValue (FunctionValue v w a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (FunctionValue v w a)

(IntoValue v a, IntoValue x a, FromValue w a) => FromValue (FunctionValue2 v x w a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (FunctionValue2 v x w a)

(IntoValue v a, IntoValue x a, IntoValue y a, FromValue w a) => FromValue (FunctionValue3 v x y w a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (FunctionValue3 v x y w a)

(IntoValue v a, IntoValue x a, IntoValue y a, IntoValue z a, FromValue w a) => FromValue (FunctionValue4 v x y z w a) a

Defined in Hakyllbars.Context

Methods

fromValue :: ContextValue a -> TemplateRunner a (FunctionValue4 v x y z w a)

class FromValue' (flag :: Bool) v a where

Methods

fromValue' :: Proxy flag -> ContextValue a -> TemplateRunner a v

Instances

FromValue' 'True String a

Defined in Hakyllbars.Context

Methods

fromValue' :: Proxy 'True -> ContextValue a -> TemplateRunner a String

FromValue v a => FromValue' 'False [v] a

Defined in Hakyllbars.Context

Methods

fromValue' :: Proxy 'False -> ContextValue a -> TemplateRunner a [v]