Text.Mustache.Types

Types for the Parser / Template

type ASTree α = [Node α]

type STree = ASTree Text

Syntax tree for a mustache template

data Node α

Basic values composing the STree

Constructors

TextBlock α

Section DataIdentifier (ASTree α)

InvertedSection DataIdentifier (ASTree α)

Variable Bool DataIdentifier

Partial (Maybe α) FilePath

Instances

Eq α => Eq (Node α)

Methods

(==) :: Node α -> Node α -> Bool

(/=) :: Node α -> Node α -> Bool

Show α => Show (Node α)

Methods

showsPrec :: Int -> Node α -> ShowS

show :: Node α -> String

showList :: [Node α] -> ShowS

Lift α0 => Lift (Node α0)

Methods

lift :: Node α0 -> Q Exp

ToMustache (Context Value -> STree -> String)

Methods

toMustache :: (Context Value -> STree -> String) -> Value

listToMustache :: [Context Value -> STree -> String] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> STree)

Methods

toMustache :: (Context Value -> STree -> STree) -> Value

listToMustache :: [Context Value -> STree -> STree] -> Value

ToMustache (STree -> Text)

Methods

toMustache :: (STree -> Text) -> Value

listToMustache :: [STree -> Text] -> Value

ToMustache (STree -> STree)

Methods

toMustache :: (STree -> STree) -> Value

listToMustache :: [STree -> STree] -> Value

data DataIdentifier

Kinds of identifiers for Variables and sections

Constructors

NamedData [Key]

Implicit

Instances

Eq DataIdentifier

Methods

(==) :: DataIdentifier -> DataIdentifier -> Bool

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

Show DataIdentifier

Methods

showsPrec :: Int -> DataIdentifier -> ShowS

show :: DataIdentifier -> String

showList :: [DataIdentifier] -> ShowS

Lift DataIdentifier

Methods

lift :: DataIdentifier -> Q Exp

data Template

A compiled Template with metadata.

Constructors

Template

Fields

• name :: String
• ast :: STree
• partials :: TemplateCache

Instances

Show Template

Methods

showsPrec :: Int -> Template -> ShowS

show :: Template -> String

showList :: [Template] -> ShowS

Lift Template

Methods

lift :: Template -> Q Exp

Lift TemplateCache

Methods

lift :: TemplateCache -> Q Exp

type TemplateCache = HashMap String Template

A collection of templates with quick access via their hashed names

Types for the Substitution / Data

data Value

Internal value representation

Constructors

Object !Object

Array !Array

Number !Scientific

String !Text

Lambda (Context Value -> STree -> STree)

Bool !Bool

Null

Instances

Show Value

Methods

showsPrec :: Int -> Value -> ShowS

show :: Value -> String

showList :: [Value] -> ShowS

ToMustache Value

Methods

toMustache :: Value -> Value

listToMustache :: [Value] -> Value

ToMustache (Context Value -> STree -> String)

Methods

toMustache :: (Context Value -> STree -> String) -> Value

listToMustache :: [Context Value -> STree -> String] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> STree)

Methods

toMustache :: (Context Value -> STree -> STree) -> Value

listToMustache :: [Context Value -> STree -> STree] -> Value

type Key = Text

Type of key used for retrieving data from Values

Converting

object :: [Pair] -> Value

Convenience function for creating Object values.

This function is supposed to be used in conjuction with the ~> and ~= operators.

Examples

  data Address = Address { ... }

  instance Address ToJSON where
    ...

  data Person = Person { name :: String, address :: Address }

  instance ToMustache Person where
    toMustache (Person { name, address }) = object
      [ "name" ~> name
      , "address" ~= address
      ]

Here we can see that we can use the ~> operator for values that have themselves a ToMustache instance, or alternatively if they lack such an instance but provide an instance for the ToJSON typeclass we can use the ~= operator.

(~>) :: ToMustache ω => Text -> ω -> Pair infixr 8

Map keys to values that provide a ToMustache instance

Recommended in conjunction with the OverloadedStrings extension.

(↝) :: ToMustache ω => Text -> ω -> Pair infixr 8

Unicode version of ~>

(~=) :: ToJSON ι => Text -> ι -> Pair infixr 8

Map keys to values that provide a ToJSON instance

Recommended in conjunction with the OverloadedStrings extension.

(⥱) :: ToJSON ι => Text -> ι -> Pair infixr 8

Unicode version of ~=

class ToMustache ω where

Conversion class

Minimal complete definition

toMustache

Methods

toMustache :: ω -> Value

Instances

ToMustache Bool

Methods

toMustache :: Bool -> Value

listToMustache :: [Bool] -> Value

ToMustache Char

Methods

toMustache :: Char -> Value

listToMustache :: [Char] -> Value

ToMustache Double

Methods

toMustache :: Double -> Value

listToMustache :: [Double] -> Value

ToMustache Float

Methods

toMustache :: Float -> Value

listToMustache :: [Float] -> Value

ToMustache Int

Methods

toMustache :: Int -> Value

listToMustache :: [Int] -> Value

ToMustache Integer

Methods

toMustache :: Integer -> Value

listToMustache :: [Integer] -> Value

ToMustache ()

Methods

toMustache :: () -> Value

listToMustache :: [()] -> Value

ToMustache Scientific

Methods

toMustache :: Scientific -> Value

listToMustache :: [Scientific] -> Value

ToMustache Text

Methods

toMustache :: Text -> Value

listToMustache :: [Text] -> Value

ToMustache Value

Methods

toMustache :: Value -> Value

listToMustache :: [Value] -> Value

ToMustache Text

Methods

toMustache :: Text -> Value

listToMustache :: [Text] -> Value

ToMustache Value

Methods

toMustache :: Value -> Value

listToMustache :: [Value] -> Value

ToMustache α => ToMustache [α]

Methods

toMustache :: [α] -> Value

listToMustache :: [[α]] -> Value

ToMustache ω => ToMustache (Maybe ω)

Methods

toMustache :: Maybe ω -> Value

listToMustache :: [Maybe ω] -> Value

ToMustache ω => ToMustache (Seq ω)

Methods

toMustache :: Seq ω -> Value

listToMustache :: [Seq ω] -> Value

ToMustache ω => ToMustache (Set ω)

Methods

toMustache :: Set ω -> Value

listToMustache :: [Set ω] -> Value

ToMustache ω => ToMustache (HashSet ω)

Methods

toMustache :: HashSet ω -> Value

listToMustache :: [HashSet ω] -> Value

ToMustache ω => ToMustache (Vector ω)

Methods

toMustache :: Vector ω -> Value

listToMustache :: [Vector ω] -> Value

ToMustache (Context Value -> STree -> String)

Methods

toMustache :: (Context Value -> STree -> String) -> Value

listToMustache :: [Context Value -> STree -> String] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> STree)

Methods

toMustache :: (Context Value -> STree -> STree) -> Value

listToMustache :: [Context Value -> STree -> STree] -> Value

ToMustache (STree -> Text)

Methods

toMustache :: (STree -> Text) -> Value

listToMustache :: [STree -> Text] -> Value

ToMustache (STree -> STree)

Methods

toMustache :: (STree -> STree) -> Value

listToMustache :: [STree -> STree] -> Value

(ToMustache α, ToMustache β) => ToMustache (α, β)

Methods

toMustache :: (α, β) -> Value

listToMustache :: [(α, β)] -> Value

ToMustache ω => ToMustache (HashMap String ω)

Methods

toMustache :: HashMap String ω -> Value

listToMustache :: [HashMap String ω] -> Value

ToMustache ω => ToMustache (HashMap Text ω)

Methods

toMustache :: HashMap Text ω -> Value

listToMustache :: [HashMap Text ω] -> Value

ToMustache ω => ToMustache (HashMap Text ω)

Methods

toMustache :: HashMap Text ω -> Value

listToMustache :: [HashMap Text ω] -> Value

ToMustache ω => ToMustache (Map String ω)

Methods

toMustache :: Map String ω -> Value

listToMustache :: [Map String ω] -> Value

ToMustache ω => ToMustache (Map Text ω)

Methods

toMustache :: Map Text ω -> Value

listToMustache :: [Map Text ω] -> Value

ToMustache ω => ToMustache (Map Text ω)

Methods

toMustache :: Map Text ω -> Value

listToMustache :: [Map Text ω] -> Value

(ToMustache α, ToMustache β, ToMustache γ) => ToMustache (α, β, γ)

Methods

toMustache :: (α, β, γ) -> Value

listToMustache :: [(α, β, γ)] -> Value

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ) => ToMustache (α, β, γ, δ)

Methods

toMustache :: (α, β, γ, δ) -> Value

listToMustache :: [(α, β, γ, δ)] -> Value

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ, ToMustache ε) => ToMustache (α, β, γ, δ, ε)

Methods

toMustache :: (α, β, γ, δ, ε) -> Value

listToMustache :: [(α, β, γ, δ, ε)] -> Value

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ, ToMustache ε, ToMustache ζ) => ToMustache (α, β, γ, δ, ε, ζ)

Methods

toMustache :: (α, β, γ, δ, ε, ζ) -> Value

listToMustache :: [(α, β, γ, δ, ε, ζ)] -> Value

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ, ToMustache ε, ToMustache ζ, ToMustache η) => ToMustache (α, β, γ, δ, ε, ζ, η)

Methods

toMustache :: (α, β, γ, δ, ε, ζ, η) -> Value

listToMustache :: [(α, β, γ, δ, ε, ζ, η)] -> Value

(ToMustache α, ToMustache β, ToMustache γ, ToMustache δ, ToMustache ε, ToMustache ζ, ToMustache η, ToMustache θ) => ToMustache (α, β, γ, δ, ε, ζ, η, θ)

Methods

toMustache :: (α, β, γ, δ, ε, ζ, η, θ) -> Value

listToMustache :: [(α, β, γ, δ, ε, ζ, η, θ)] -> Value

toMustache :: ToMustache ω => ω -> Value

mFromJSON :: ToJSON ι => ι -> Value

Converts a value that can be represented as JSON to a Value.

Representation

type Array = Vector Value

A list-like structure used in Value

type Object = HashMap Text Value

A map-like structure used in Value

type Pair = (Text, Value)

Source type for constructing Objects

data Context α

Representation of stateful context for the substitution process

Constructors

Context [α] α

Instances

Eq α => Eq (Context α)

Methods

(==) :: Context α -> Context α -> Bool

(/=) :: Context α -> Context α -> Bool

Ord α => Ord (Context α)

Methods

compare :: Context α -> Context α -> Ordering

(<) :: Context α -> Context α -> Bool

(<=) :: Context α -> Context α -> Bool

(>) :: Context α -> Context α -> Bool

(>=) :: Context α -> Context α -> Bool

max :: Context α -> Context α -> Context α

min :: Context α -> Context α -> Context α

Show α => Show (Context α)

Methods

showsPrec :: Int -> Context α -> ShowS

show :: Context α -> String

showList :: [Context α] -> ShowS

ToMustache (Context Value -> STree -> String)

Methods

toMustache :: (Context Value -> STree -> String) -> Value

listToMustache :: [Context Value -> STree -> String] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> Text)

Methods

toMustache :: (Context Value -> STree -> Text) -> Value

listToMustache :: [Context Value -> STree -> Text] -> Value

ToMustache (Context Value -> STree -> STree)

Methods

toMustache :: (Context Value -> STree -> STree) -> Value

listToMustache :: [Context Value -> STree -> STree] -> Value

Orphan instances

Lift Text

Methods

lift :: Text -> Q Exp