Text.DocTemplates.Internal

Documentation

renderTemplate :: (TemplateTarget a, ToContext a b) => Template -> b -> a

Render a compiled template in a "context" which provides values for the template's variables.

class Monad m => TemplateMonad m where

A TemplateMonad defines a function to retrieve a partial (from the file system, from a database, or using a default value).

Methods

getPartial :: FilePath -> m Text

Instances

TemplateMonad IO

Defined in Text.DocTemplates.Internal

Methods

getPartial :: FilePath -> IO Text

TemplateMonad Identity

Defined in Text.DocTemplates.Internal

Methods

getPartial :: FilePath -> Identity Text

newtype Context a

A Context defines values for template's variables.

Constructors

Context

Fields

• unContext :: Map Text (Val a)

Instances

Functor Context

Defined in Text.DocTemplates.Internal

Methods

fmap :: (a -> b) -> Context a -> Context b

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

Foldable Context

Defined in Text.DocTemplates.Internal

Methods

fold :: Monoid m => Context m -> m

foldMap :: Monoid m => (a -> m) -> Context a -> m

foldr :: (a -> b -> b) -> b -> Context a -> b

foldr' :: (a -> b -> b) -> b -> Context a -> b

foldl :: (b -> a -> b) -> b -> Context a -> b

foldl' :: (b -> a -> b) -> b -> Context a -> b

foldr1 :: (a -> a -> a) -> Context a -> a

foldl1 :: (a -> a -> a) -> Context a -> a

toList :: Context a -> [a]

null :: Context a -> Bool

length :: Context a -> Int

elem :: Eq a => a -> Context a -> Bool

maximum :: Ord a => Context a -> a

minimum :: Ord a => Context a -> a

sum :: Num a => Context a -> a

product :: Num a => Context a -> a

Traversable Context

Defined in Text.DocTemplates.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Context a -> f (Context b)

sequenceA :: Applicative f => Context (f a) -> f (Context a)

mapM :: Monad m => (a -> m b) -> Context a -> m (Context b)

sequence :: Monad m => Context (m a) -> m (Context a)

TemplateTarget a => ToContext a (Context a)

Defined in Text.DocTemplates.Internal

Methods

toContext :: Context a -> Context a

toVal :: Context a -> Val a

Show a => Show (Context a)

Defined in Text.DocTemplates.Internal

Methods

showsPrec :: Int -> Context a -> ShowS

show :: Context a -> String

showList :: [Context a] -> ShowS

Semigroup (Context a)

Defined in Text.DocTemplates.Internal

Methods

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

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

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

Monoid (Context a)

Defined in Text.DocTemplates.Internal

Methods

mempty :: Context a

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

mconcat :: [Context a] -> Context a

TemplateTarget a => ToJSON (Context a)

Defined in Text.DocTemplates.Internal

Methods

toJSON :: Context a -> Value

toEncoding :: Context a -> Encoding

toJSONList :: [Context a] -> Value

toEncodingList :: [Context a] -> Encoding

TemplateTarget a => FromJSON (Context a)

Defined in Text.DocTemplates.Internal

Methods

parseJSON :: Value -> Parser (Context a)

parseJSONList :: Value -> Parser [Context a]

data Val a

A variable value.

Constructors

SimpleVal a

ListVal [Val a]

MapVal (Context a)

NullVal

Instances

Functor Val

Defined in Text.DocTemplates.Internal

Methods

fmap :: (a -> b) -> Val a -> Val b

(<$) :: a -> Val b -> Val a

Foldable Val

Defined in Text.DocTemplates.Internal

Methods

fold :: Monoid m => Val m -> m

foldMap :: Monoid m => (a -> m) -> Val a -> m

foldr :: (a -> b -> b) -> b -> Val a -> b

foldr' :: (a -> b -> b) -> b -> Val a -> b

foldl :: (b -> a -> b) -> b -> Val a -> b

foldl' :: (b -> a -> b) -> b -> Val a -> b

foldr1 :: (a -> a -> a) -> Val a -> a

foldl1 :: (a -> a -> a) -> Val a -> a

toList :: Val a -> [a]

null :: Val a -> Bool

length :: Val a -> Int

elem :: Eq a => a -> Val a -> Bool

maximum :: Ord a => Val a -> a

minimum :: Ord a => Val a -> a

sum :: Num a => Val a -> a

product :: Num a => Val a -> a

Traversable Val

Defined in Text.DocTemplates.Internal

Methods

traverse :: Applicative f => (a -> f b) -> Val a -> f (Val b)

sequenceA :: Applicative f => Val (f a) -> f (Val a)

mapM :: Monad m => (a -> m b) -> Val a -> m (Val b)

sequence :: Monad m => Val (m a) -> m (Val a)

TemplateTarget a => FromContext a (Val a)

Defined in Text.DocTemplates.Internal

Methods

fromVal :: Val a -> Maybe (Val a)

lookupContext :: Text -> Context a -> Maybe (Val a)

TemplateTarget a => ToContext a (Val a)

Defined in Text.DocTemplates.Internal

Methods

toContext :: Val a -> Context a

toVal :: Val a -> Val a

Show a => Show (Val a)

Defined in Text.DocTemplates.Internal

Methods

showsPrec :: Int -> Val a -> ShowS

show :: Val a -> String

showList :: [Val a] -> ShowS

TemplateTarget a => ToJSON (Val a)

Defined in Text.DocTemplates.Internal

Methods

toJSON :: Val a -> Value

toEncoding :: Val a -> Encoding

toJSONList :: [Val a] -> Value

toEncodingList :: [Val a] -> Encoding

TemplateTarget a => FromJSON (Val a)

Defined in Text.DocTemplates.Internal

Methods

parseJSON :: Value -> Parser (Val a)

parseJSONList :: Value -> Parser [Val a]

class ToContext a b where

The ToContext class provides automatic conversion to a Context or Val.

Minimal complete definition

toVal

Methods

toContext :: b -> Context a

toVal :: b -> Val a

Instances

TemplateTarget a => ToContext a Bool

Defined in Text.DocTemplates.Internal

Methods

toContext :: Bool -> Context a

toVal :: Bool -> Val a

TemplateTarget a => ToContext a Value

Defined in Text.DocTemplates.Internal

Methods

toContext :: Value -> Context a

toVal :: Value -> Val a

TemplateTarget a => ToContext a a

Defined in Text.DocTemplates.Internal

Methods

toContext :: a -> Context a

toVal :: a -> Val a

ToContext String String

Defined in Text.DocTemplates.Internal

Methods

toContext :: String -> Context String

toVal :: String -> Val String

ToContext a b => ToContext a [b]

Defined in Text.DocTemplates.Internal

Methods

toContext :: [b] -> Context a

toVal :: [b] -> Val a

TemplateTarget a => ToContext a (Val a)

Defined in Text.DocTemplates.Internal

Methods

toContext :: Val a -> Context a

toVal :: Val a -> Val a

TemplateTarget a => ToContext a (Context a)

Defined in Text.DocTemplates.Internal

Methods

toContext :: Context a -> Context a

toVal :: Context a -> Val a

(TemplateTarget a, HasChars a) => ToContext (Doc a) a

Defined in Text.DocTemplates.Internal

Methods

toContext :: a -> Context (Doc a)

toVal :: a -> Val (Doc a)

class FromContext a b where

The FromContext class provides functions for extracting values from Val and Context.

Minimal complete definition

fromVal

Methods

fromVal :: Val a -> Maybe b

lookupContext :: Text -> Context a -> Maybe b

Instances

TemplateTarget a => FromContext a a

Defined in Text.DocTemplates.Internal

Methods

fromVal :: Val a -> Maybe a

lookupContext :: Text -> Context a -> Maybe a

FromContext String String

Defined in Text.DocTemplates.Internal

Methods

fromVal :: Val String -> Maybe String

lookupContext :: Text -> Context String -> Maybe String

FromContext a b => FromContext a [b]

Defined in Text.DocTemplates.Internal

Methods

fromVal :: Val a -> Maybe [b]

lookupContext :: Text -> Context a -> Maybe [b]

TemplateTarget a => FromContext a (Val a)

Defined in Text.DocTemplates.Internal

Methods

fromVal :: Val a -> Maybe (Val a)

lookupContext :: Text -> Context a -> Maybe (Val a)

class Monoid a => TemplateTarget a where

A type to which templates can be rendered.

Methods

fromText :: Text -> a

toText :: a -> Text

removeFinalNewline :: a -> a

isEmpty :: a -> Bool

indent :: Int -> a -> a

breakingSpace :: a

Instances

TemplateTarget Text

Defined in Text.DocTemplates.Internal

Methods

fromText :: Text -> Text

toText :: Text -> Text

removeFinalNewline :: Text -> Text

isEmpty :: Text -> Bool

indent :: Int -> Text -> Text

breakingSpace :: Text

TemplateTarget Text

Defined in Text.DocTemplates.Internal

Methods

fromText :: Text0 -> Text

toText :: Text -> Text0

removeFinalNewline :: Text -> Text

isEmpty :: Text -> Bool

indent :: Int -> Text -> Text

breakingSpace :: Text

TemplateTarget String

Defined in Text.DocTemplates.Internal

Methods

fromText :: Text -> String

toText :: String -> Text

removeFinalNewline :: String -> String

isEmpty :: String -> Bool

indent :: Int -> String -> String

breakingSpace :: String

(HasChars a, IsString a, Eq a) => TemplateTarget (Doc a)

Defined in Text.DocTemplates.Internal

Methods

fromText :: Text -> Doc a

toText :: Doc a -> Text

removeFinalNewline :: Doc a -> Doc a

isEmpty :: Doc a -> Bool

indent :: Int -> Doc a -> Doc a

breakingSpace :: Doc a

data Template

A template.

Constructors

Interpolate Variable

Conditional Variable Template Template

Iterate Variable Template Template

Nested Int Template

Partial Template

Literal Text

Concat Template Template

BreakingSpace

Empty

Instances

Eq Template

Defined in Text.DocTemplates.Internal

Methods

(==) :: Template -> Template -> Bool

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

Data Template

Defined in Text.DocTemplates.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Template -> c Template

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Template

toConstr :: Template -> Constr

dataTypeOf :: Template -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Template)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Template)

gmapT :: (forall b. Data b => b -> b) -> Template -> Template

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Template -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Template -> r

gmapQ :: (forall d. Data d => d -> u) -> Template -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Template -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Template -> m Template

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Template -> m Template

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Template -> m Template

Ord Template

Defined in Text.DocTemplates.Internal

Methods

compare :: Template -> Template -> Ordering

(<) :: Template -> Template -> Bool

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

(>) :: Template -> Template -> Bool

(>=) :: Template -> Template -> Bool

max :: Template -> Template -> Template

min :: Template -> Template -> Template

Read Template

Defined in Text.DocTemplates.Internal

Methods

readsPrec :: Int -> ReadS Template

readList :: ReadS [Template]

readPrec :: ReadPrec Template

readListPrec :: ReadPrec [Template]

Show Template

Defined in Text.DocTemplates.Internal

Methods

showsPrec :: Int -> Template -> ShowS

show :: Template -> String

showList :: [Template] -> ShowS

Generic Template

Defined in Text.DocTemplates.Internal

Associated Types

type Rep Template :: Type -> Type

Methods

from :: Template -> Rep Template x

to :: Rep Template x -> Template

Semigroup Template

Defined in Text.DocTemplates.Internal

Methods

(<>) :: Template -> Template -> Template

sconcat :: NonEmpty Template -> Template

stimes :: Integral b => b -> Template -> Template

Monoid Template

Defined in Text.DocTemplates.Internal

Methods

mempty :: Template

mappend :: Template -> Template -> Template

mconcat :: [Template] -> Template

type Rep Template

Defined in Text.DocTemplates.Internal

type Rep Template = D1 (MetaData "Template" "Text.DocTemplates.Internal" "doctemplates-0.6-KXFySz9w7Yu9pgADJ55XK9" False) (((C1 (MetaCons "Interpolate" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Variable)) :+: C1 (MetaCons "Conditional" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Variable) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template)))) :+: (C1 (MetaCons "Iterate" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Variable) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template))) :+: C1 (MetaCons "Nested" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template)))) :+: ((C1 (MetaCons "Partial" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template)) :+: C1 (MetaCons "Literal" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Text))) :+: (C1 (MetaCons "Concat" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Template)) :+: (C1 (MetaCons "BreakingSpace" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Empty" PrefixI False) (U1 :: Type -> Type)))))

newtype Variable

A variable which may have several parts (foo.bar.baz).

Constructors

Variable

Fields

• unVariable :: [Text]

Instances

Eq Variable

Defined in Text.DocTemplates.Internal

Methods

(==) :: Variable -> Variable -> Bool

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

Data Variable

Defined in Text.DocTemplates.Internal

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> Variable -> c Variable

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c Variable

toConstr :: Variable -> Constr

dataTypeOf :: Variable -> DataType

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c Variable)

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Variable)

gmapT :: (forall b. Data b => b -> b) -> Variable -> Variable

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> Variable -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> Variable -> r

gmapQ :: (forall d. Data d => d -> u) -> Variable -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> Variable -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> Variable -> m Variable

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> Variable -> m Variable

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> Variable -> m Variable

Ord Variable

Defined in Text.DocTemplates.Internal

Methods

compare :: Variable -> Variable -> Ordering

(<) :: Variable -> Variable -> Bool

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

(>) :: Variable -> Variable -> Bool

(>=) :: Variable -> Variable -> Bool

max :: Variable -> Variable -> Variable

min :: Variable -> Variable -> Variable

Read Variable

Defined in Text.DocTemplates.Internal

Methods

readsPrec :: Int -> ReadS Variable

readList :: ReadS [Variable]

readPrec :: ReadPrec Variable

readListPrec :: ReadPrec [Variable]

Show Variable

Defined in Text.DocTemplates.Internal

Methods

showsPrec :: Int -> Variable -> ShowS

show :: Variable -> String

showList :: [Variable] -> ShowS

Generic Variable

Defined in Text.DocTemplates.Internal

Associated Types

type Rep Variable :: Type -> Type

Methods

from :: Variable -> Rep Variable x

to :: Rep Variable x -> Variable

Semigroup Variable

Defined in Text.DocTemplates.Internal

Methods

(<>) :: Variable -> Variable -> Variable

sconcat :: NonEmpty Variable -> Variable

stimes :: Integral b => b -> Variable -> Variable

Monoid Variable

Defined in Text.DocTemplates.Internal

Methods

mempty :: Variable

mappend :: Variable -> Variable -> Variable

mconcat :: [Variable] -> Variable

type Rep Variable

Defined in Text.DocTemplates.Internal

type Rep Variable = D1 (MetaData "Variable" "Text.DocTemplates.Internal" "doctemplates-0.6-KXFySz9w7Yu9pgADJ55XK9" True) (C1 (MetaCons "Variable" PrefixI True) (S1 (MetaSel (Just "unVariable") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [Text])))