Moduledoctemplates-0.11Haskell2010

Text.DocTemplates.Internal

8 types
3 classes
1 value

Packagedoctemplates-0.11
Exports12
LanguageHaskell2010
LicenceBSD-3-Clause
SourceInternal.hs

valuerenderTemplate

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

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

classclass Monad m => TemplateMonad (m :: Type -> Type) 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

Instances2TemplateMonad

TemplateMonad IdentityDefined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateMonad IODefined in doctemplates-0.11 · Text.DocTemplates.Internal

newtypenewtype Context a

A Context defines values for template's variables.

Constructors

Context
- unContext :: Map Text (Val a)

Instances10Functor, Foldable, Traversable, ToContext, Data, Show, …

Functor ContextDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Foldable ContextDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Traversable ContextDefined in doctemplates-0.11 · Text.DocTemplates.Internal
ToContext a (Context a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Data a => Data (Context a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Show a => Show (Context a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Semigroup (Context a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Monoid (Context a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => FromJSON (Context a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => ToJSON (Context a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal

datadata Val a

A variable value.

Constructors

SimpleVal (Doc a)
ListVal [Val a]
MapVal (Context a)
BoolVal Bool
NullVal

Instances9Functor, Foldable, Traversable, FromContext, ToContext, Data, …

Functor ValDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Foldable ValDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Traversable ValDefined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => FromContext a (Val a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
ToContext a (Val a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Data a => Data (Val a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Show a => Show (Val a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => FromJSON (Val a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => ToJSON (Val a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal

classclass ToContext a b where

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

Methods

toContext :: b -> Context a
toVal :: b -> Val a

Instances9ToContext, …

TemplateTarget a => ToContext a ValueDefined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => ToContext a BoolDefined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => ToContext a aDefined in doctemplates-0.11 · Text.DocTemplates.Internal
ToContext a (Context a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
ToContext a (Val a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
ToContext a a => ToContext a (Doc a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
ToContext a b => ToContext a [b]Defined in doctemplates-0.11 · Text.DocTemplates.Internal
ToContext a b => ToContext a (Map Text b)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget [a] => ToContext [a] [a]Defined in doctemplates-0.11 · Text.DocTemplates.Internal

classclass FromContext a b where

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

Methods

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

Instances5FromContext

TemplateTarget a => FromContext a aDefined in doctemplates-0.11 · Text.DocTemplates.Internal
FromContext a b => FromContext a [b]Defined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => FromContext a (Doc a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget a => FromContext a (Val a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
TemplateTarget [a] => FromContext [a] [a]Defined in doctemplates-0.11 · Text.DocTemplates.Internal

typetype TemplateTarget a = (HasChars a, ToText a, FromText a)

datadata Template a

A template.

Constructors

Interpolate Variable
Conditional Variable (Template a) (Template a)
Iterate Variable (Template a) (Template a)
Nested (Template a)
Partial [Pipe] (Template a)
Literal (Doc a)
Concat (Template a) (Template a)
Empty

Instances12Functor, Foldable, Traversable, Eq, Data, Ord, …

Functor TemplateDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Foldable TemplateDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Traversable TemplateDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Eq a => Eq (Template a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Data a => Data (Template a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Ord a => Ord (Template a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Read a => Read (Template a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Show a => Show (Template a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Generic (Template a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Semigroup a => Semigroup (Template a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
Semigroup a => Monoid (Template a)Defined in doctemplates-0.11 · Text.DocTemplates.Internal
type Rep (Template a) = D1 ('MetaData "Template" "Text.DocTemplates.Internal" "doctemplates-0.11-Bs6c8x0RQye6gfRxj8qbrF" 'False) (((C1 ('MetaCons "Interpolate" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable)) :+: C1 ('MetaCons "Conditional" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))))) :+: (C1 ('MetaCons "Iterate" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Variable) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)))) :+: C1 ('MetaCons "Nested" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))))) :+: ((C1 ('MetaCons "Partial" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Pipe]) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))) :+: C1 ('MetaCons "Literal" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Doc a)))) :+: (C1 ('MetaCons "Concat" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a)) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Template a))) :+: C1 ('MetaCons "Empty" 'PrefixI 'False) U1)))Defined in doctemplates-0.11 · Text.DocTemplates.Internal

datadata Variable

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

Constructors

Variable
- varParts :: [Text]
- varPipes :: [Pipe]

Instances9Eq, Data, Ord, Read, Show, Generic, …

Eq VariableDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Data VariableDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Ord VariableDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Read VariableDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Show VariableDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Generic VariableDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Semigroup VariableDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Monoid VariableDefined in doctemplates-0.11 · Text.DocTemplates.Internal
type Rep Variable = D1 ('MetaData "Variable" "Text.DocTemplates.Internal" "doctemplates-0.11-Bs6c8x0RQye6gfRxj8qbrF" 'False) (C1 ('MetaCons "Variable" 'PrefixI 'True) (S1 ('MetaSel ('Just "varParts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Text]) :*: S1 ('MetaSel ('Just "varPipes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [Pipe])))Defined in doctemplates-0.11 · Text.DocTemplates.Internal

datadata Pipe

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq PipeDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Data PipeDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Ord PipeDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Read PipeDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Show PipeDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Generic PipeDefined in doctemplates-0.11 · Text.DocTemplates.Internal
type Rep Pipe = D1 ('MetaData "Pipe" "Text.DocTemplates.Internal" "doctemplates-0.11-Bs6c8x0RQye6gfRxj8qbrF" 'False) (((C1 ('MetaCons "ToPairs" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "ToUppercase" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ToLowercase" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "ToLength" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Reverse" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "FirstItem" 'PrefixI 'False) U1 :+: C1 ('MetaCons "LastItem" 'PrefixI 'False) U1))) :+: ((C1 ('MetaCons "Rest" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "AllButLast" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Chomp" 'PrefixI 'False) U1)) :+: ((C1 ('MetaCons "ToAlpha" 'PrefixI 'False) U1 :+: C1 ('MetaCons "ToRoman" 'PrefixI 'False) U1) :+: (C1 ('MetaCons "NoWrap" 'PrefixI 'False) U1 :+: C1 ('MetaCons "Block" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Alignment) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Border)))))))Defined in doctemplates-0.11 · Text.DocTemplates.Internal

datadata Alignment

LeftAligned Centered RightAligned

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq AlignmentDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Data AlignmentDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Ord AlignmentDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Read AlignmentDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Show AlignmentDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Generic AlignmentDefined in doctemplates-0.11 · Text.DocTemplates.Internal
type Rep Alignment = D1 ('MetaData "Alignment" "Text.DocTemplates.Internal" "doctemplates-0.11-Bs6c8x0RQye6gfRxj8qbrF" 'False) (C1 ('MetaCons "LeftAligned" 'PrefixI 'False) U1 :+: (C1 ('MetaCons "Centered" 'PrefixI 'False) U1 :+: C1 ('MetaCons "RightAligned" 'PrefixI 'False) U1))Defined in doctemplates-0.11 · Text.DocTemplates.Internal

datadata Border

Constructors

Border
- borderLeft :: Text
- borderRight :: Text

Instances7Eq, Data, Ord, Read, Show, Generic, …

Eq BorderDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Data BorderDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Ord BorderDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Read BorderDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Show BorderDefined in doctemplates-0.11 · Text.DocTemplates.Internal
Generic BorderDefined in doctemplates-0.11 · Text.DocTemplates.Internal
type Rep Border = D1 ('MetaData "Border" "Text.DocTemplates.Internal" "doctemplates-0.11-Bs6c8x0RQye6gfRxj8qbrF" 'False) (C1 ('MetaCons "Border" 'PrefixI 'True) (S1 ('MetaSel ('Just "borderLeft") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text) :*: S1 ('MetaSel ('Just "borderRight") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))Defined in doctemplates-0.11 · Text.DocTemplates.Internal