Heist.Internal.Types

Internal types and accessors. There are no guarantees that heist will preserve backwards compatibility for symbols in this module. If you use them, no complaining when your code breaks.

Documentation

type Splices s = MapSyntax Text s

Convenient type alies for splices.

type Template = [Node]

A Template is a forest of XML nodes. Here we deviate from the "single root node" constraint of well-formed XML because we want to allow templates to contain document fragments that may not have a single root.

type MIMEType = ByteString

MIME Type. The type alias is here to make the API clearer.

type TPath = [ByteString]

Reversed list of directories. This holds the path to the template currently being processed.

data DocumentFile

Holds data about templates read from disk.

Constructors

DocumentFile

Fields

• dfDoc :: Document
• dfFile :: Maybe FilePath

Instances

Eq DocumentFile

Defined in Heist.Internal.Types.HeistState

Methods

(==) :: DocumentFile -> DocumentFile -> Bool

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

Show DocumentFile

Defined in Heist.Internal.Types.HeistState

Methods

showsPrec :: Int -> DocumentFile -> ShowS

show :: DocumentFile -> String

showList :: [DocumentFile] -> ShowS

data Markup

Designates whether a document should be treated as XML or HTML.

Constructors

Xml

Html

newtype RuntimeSplice m a

Monad used for runtime splice execution.

Constructors

RuntimeSplice

Fields

• unRT :: StateT HeterogeneousEnvironment m a

Instances

MonadTrans RuntimeSplice

Defined in Heist.Internal.Types.HeistState

Methods

lift :: Monad m => m a -> RuntimeSplice m a

Monad m => Monad (RuntimeSplice m)

Defined in Heist.Internal.Types.HeistState

Methods

(>>=) :: RuntimeSplice m a -> (a -> RuntimeSplice m b) -> RuntimeSplice m b

(>>) :: RuntimeSplice m a -> RuntimeSplice m b -> RuntimeSplice m b

return :: a -> RuntimeSplice m a

fail :: String -> RuntimeSplice m a

Functor m => Functor (RuntimeSplice m)

Defined in Heist.Internal.Types.HeistState

Methods

fmap :: (a -> b) -> RuntimeSplice m a -> RuntimeSplice m b

(<$) :: a -> RuntimeSplice m b -> RuntimeSplice m a

Monad m => Applicative (RuntimeSplice m)

Defined in Heist.Internal.Types.HeistState

Methods

pure :: a -> RuntimeSplice m a

(<*>) :: RuntimeSplice m (a -> b) -> RuntimeSplice m a -> RuntimeSplice m b

liftA2 :: (a -> b -> c) -> RuntimeSplice m a -> RuntimeSplice m b -> RuntimeSplice m c

(*>) :: RuntimeSplice m a -> RuntimeSplice m b -> RuntimeSplice m b

(<*) :: RuntimeSplice m a -> RuntimeSplice m b -> RuntimeSplice m a

MonadIO m => MonadIO (RuntimeSplice m)

Defined in Heist.Internal.Types.HeistState

Methods

liftIO :: IO a -> RuntimeSplice m a

(Monad m, Semigroup a) => Semigroup (RuntimeSplice m a)

Defined in Heist.Internal.Types.HeistState

Methods

(<>) :: RuntimeSplice m a -> RuntimeSplice m a -> RuntimeSplice m a

sconcat :: NonEmpty (RuntimeSplice m a) -> RuntimeSplice m a

stimes :: Integral b => b -> RuntimeSplice m a -> RuntimeSplice m a

(Monad m, Monoid a) => Monoid (RuntimeSplice m a)

Defined in Heist.Internal.Types.HeistState

Methods

mempty :: RuntimeSplice m a

mappend :: RuntimeSplice m a -> RuntimeSplice m a -> RuntimeSplice m a

mconcat :: [RuntimeSplice m a] -> RuntimeSplice m a

data Chunk m

Opaque type representing pieces of output from compiled splices.

Constructors

Pure !ByteString

output known at load time

RuntimeHtml !(RuntimeSplice m Builder)

output computed at run time

RuntimeAction !(RuntimeSplice m ())

runtime action used only for its side-effect

Instances

Show (Chunk m)

Defined in Heist.Internal.Types.HeistState

Methods

showsPrec :: Int -> Chunk m -> ShowS

show :: Chunk m -> String

showList :: [Chunk m] -> ShowS

showChunk :: Chunk m -> String

isPureChunk :: Chunk m -> Bool

type AttrSplice m = Text -> RuntimeSplice m [(Text, Text)]

Type alias for attribute splices. The function parameter is the value of the bound attribute splice. The return value is a list of attribute key/value pairs that get substituted in the place of the bound attribute.

data SpliceError

Detailed information about a splice error.

Constructors

SpliceError

Fields

• spliceHistory :: [(TPath, Maybe FilePath, Text)]
• spliceTemplateFile :: Maybe FilePath
• visibleSplices :: [Text]
• contextNode :: Node
• spliceMsg :: Text

Instances

Eq SpliceError

Defined in Heist.Internal.Types.HeistState

Methods

(==) :: SpliceError -> SpliceError -> Bool

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

Show SpliceError

Defined in Heist.Internal.Types.HeistState

Methods

showsPrec :: Int -> SpliceError -> ShowS

show :: SpliceError -> String

showList :: [SpliceError] -> ShowS

spliceErrorText :: SpliceError -> Text

Transform a SpliceError record to a Text message.

data CompileException

Exception type for splice compile errors. Wraps the original exception and provides context. data (Exception e) => CompileException e = CompileException

Constructors

Exception e => CompileException

Fields

• originalException :: e
• exceptionContext :: [SpliceError]

Instances

Show CompileException

Defined in Heist.Internal.Types.HeistState

Methods

showsPrec :: Int -> CompileException -> ShowS

show :: CompileException -> String

showList :: [CompileException] -> ShowS

Exception CompileException

Defined in Heist.Internal.Types.HeistState

Methods

toException :: CompileException -> SomeException

fromException :: SomeException -> Maybe CompileException

displayException :: CompileException -> String

data HeistState m

Holds all the state information needed for template processing. You will build a HeistState using initHeist and any of Heist's HeistState -> HeistState "filter" functions. Then you use the resulting HeistState in calls to renderTemplate.

m is the runtime monad

Constructors

HeistState

Fields

• _spliceMap :: HashMap Text (HeistT m m Template)

  A mapping of splice names to splice actions

• _templateMap :: HashMap TPath DocumentFile

  A mapping of template names to templates

• _compiledSpliceMap :: HashMap Text (HeistT m IO (DList (Chunk m)))

  A mapping of splice names to splice actions

• _compiledTemplateMap :: !(HashMap TPath ([Chunk m], MIMEType))

  A mapping of template names to templates , _compiledTemplateMap :: HashMap TPath (m Builder, MIMEType)

• _attrSpliceMap :: HashMap Text (AttrSplice m)
• _recurse :: Bool

  A flag to control splice recursion

• _curContext :: TPath

  The path to the template currently being processed.

• _splicePath :: [(TPath, Maybe FilePath, Text)]

  Stack of the splices used.

• _recursionDepth :: Int

  A counter keeping track of the current recursion depth to prevent infinite loops.

• _doctypes :: [DocType]

  The doctypes encountered during template processing.

• _curTemplateFile :: Maybe FilePath

  The full path to the current template's file on disk.

• _keygen :: KeyGen

  A key generator used to produce new unique Promises.

• _preprocessingMode :: Bool

  Flag indicating whether we're in preprocessing mode. During preprocessing, errors should stop execution and be reported. During template rendering, it's better to skip the errors and render the page.

• _curMarkup :: Markup

  This is needed because compiled templates are generated with a bunch of calls to renderFragment rather than a single call to render.

• _splicePrefix :: Text

  A prefix for all splices (namespace ++ ":").

• _spliceErrors :: [SpliceError]

  List of errors encountered during splice processing.

• _errorNotBound :: Bool

  Whether to throw an error when a tag wih the heist namespace does not correspond to a bound splice. When not using a namespace, this flag is ignored.

• _numNamespacedTags :: Int

newtype HeistT n m a

HeistT is the monad transformer used for splice processing. HeistT intentionally does not expose any of its functionality via MonadState or MonadReader functions. We define passthrough instances for the most common types of monads. These instances allow the user to use HeistT in a monad stack without needing calls to lift.

n is the runtime monad (the parameter to HeistState).

m is the monad being run now. In this case, "now" is a variable concept. The type HeistT n n means that "now" is runtime. The type HeistT n IO means that "now" is IO, and more importantly it is NOT runtime. In Heist, the rule of thumb is that IO means load time and n means runtime.

Constructors

HeistT

Fields

• runHeistT :: Node -> HeistState n -> m (a, HeistState n)

Instances

MonadBase b m => MonadBase b (HeistT n m)

Defined in Heist.Internal.Types.HeistState

Methods

liftBase :: b α -> HeistT n m α

MonadBaseControl b m => MonadBaseControl b (HeistT n m)

Defined in Heist.Internal.Types.HeistState

Associated Types

type StM (HeistT n m) a :: *

Methods

liftBaseWith :: (RunInBase (HeistT n m) b -> b a) -> HeistT n m a

restoreM :: StM (HeistT n m) a -> HeistT n m a

MonadState s m => MonadState s (HeistT n m)

MonadState passthrough instance

Defined in Heist.Internal.Types.HeistState

Methods

get :: HeistT n m s

put :: s -> HeistT n m ()

state :: (s -> (a, s)) -> HeistT n m a

MonadReader r m => MonadReader r (HeistT n m)

MonadReader passthrough instance

Defined in Heist.Internal.Types.HeistState

Methods

ask :: HeistT n m r

local :: (r -> r) -> HeistT n m a -> HeistT n m a

reader :: (r -> a) -> HeistT n m a

MonadError e m => MonadError e (HeistT n m)

MonadError passthrough instance

Defined in Heist.Internal.Types.HeistState

Methods

throwError :: e -> HeistT n m a

catchError :: HeistT n m a -> (e -> HeistT n m a) -> HeistT n m a

MonadTrans (HeistT n)

MonadTrans instance

Defined in Heist.Internal.Types.HeistState

Methods

lift :: Monad m => m a -> HeistT n m a

MonadTransControl (HeistT n)

Defined in Heist.Internal.Types.HeistState

Associated Types

type StT (HeistT n) a :: *

Methods

liftWith :: Monad m => (Run (HeistT n) -> m a) -> HeistT n m a

restoreT :: Monad m => m (StT (HeistT n) a) -> HeistT n m a

Monad m => Monad (HeistT n m)

Monad instance

Defined in Heist.Internal.Types.HeistState

Methods

(>>=) :: HeistT n m a -> (a -> HeistT n m b) -> HeistT n m b

(>>) :: HeistT n m a -> HeistT n m b -> HeistT n m b

return :: a -> HeistT n m a

fail :: String -> HeistT n m a

Functor m => Functor (HeistT n m)

Functor instance

Defined in Heist.Internal.Types.HeistState

Methods

fmap :: (a -> b) -> HeistT n m a -> HeistT n m b

(<$) :: a -> HeistT n m b -> HeistT n m a

MonadFix m => MonadFix (HeistT n m)

MonadFix passthrough instance

Defined in Heist.Internal.Types.HeistState

Methods

mfix :: (a -> HeistT n m a) -> HeistT n m a

MonadFail m => MonadFail (HeistT n m)

MonadFail instance

Defined in Heist.Internal.Types.HeistState

Methods

fail :: String -> HeistT n m a

(Monad m, Functor m) => Applicative (HeistT n m)

Applicative instance

Defined in Heist.Internal.Types.HeistState

Methods

pure :: a -> HeistT n m a

(<*>) :: HeistT n m (a -> b) -> HeistT n m a -> HeistT n m b

liftA2 :: (a -> b -> c) -> HeistT n m a -> HeistT n m b -> HeistT n m c

(*>) :: HeistT n m a -> HeistT n m b -> HeistT n m b

(<*) :: HeistT n m a -> HeistT n m b -> HeistT n m a

(Functor m, MonadPlus m) => Alternative (HeistT n m)

Alternative passthrough instance

Defined in Heist.Internal.Types.HeistState

Methods

empty :: HeistT n m a

(<|>) :: HeistT n m a -> HeistT n m a -> HeistT n m a

some :: HeistT n m a -> HeistT n m [a]

many :: HeistT n m a -> HeistT n m [a]

MonadPlus m => MonadPlus (HeistT n m)

MonadPlus passthrough instance

Defined in Heist.Internal.Types.HeistState

Methods

mzero :: HeistT n m a

mplus :: HeistT n m a -> HeistT n m a -> HeistT n m a

MonadIO m => MonadIO (HeistT n m)

MonadIO instance

Defined in Heist.Internal.Types.HeistState

Methods

liftIO :: IO a -> HeistT n m a

MonadCont m => MonadCont (HeistT n m)

MonadCont passthrough instance

Defined in Heist.Internal.Types.HeistState

Methods

callCC :: ((a -> HeistT n m b) -> HeistT n m a) -> HeistT n m a

type StT (HeistT n) a

Defined in Heist.Internal.Types.HeistState

type StT (HeistT n) a = (a, HeistState n)

type StM (HeistT n m) a

Defined in Heist.Internal.Types.HeistState

type StM (HeistT n m) a = ComposeSt (HeistT n) m a

templateNames :: HeistState m -> [TPath]

Gets the names of all the templates defined in a HeistState.

compiledTemplateNames :: HeistState m -> [TPath]

Gets the names of all the templates defined in a HeistState.

spliceNames :: HeistState m -> [Text]

Gets the names of all the interpreted splices defined in a HeistState.

compiledSpliceNames :: HeistState m -> [Text]

Gets the names of all the compiled splices defined in a HeistState.

evalHeistT :: Monad m => HeistT n m a -> Node -> HeistState n -> m a

Evaluates a template monad as a computation in the underlying monad.

_liftCatch :: (m (a, HeistState n) -> (e -> m (a, HeistState n)) -> m (a, HeistState n)) -> HeistT n m a -> (e -> HeistT n m a) -> HeistT n m a

Helper for MonadError instance.

_liftCallCC :: ((((a, HeistState n) -> m (b, HeistState n)) -> m (a, HeistState n)) -> m (a, HeistState n)) -> ((a -> HeistT n m b) -> HeistT n m a) -> HeistT n m a

Helper for MonadCont instance.

getParamNode :: Monad m => HeistT n m Node

Gets the node currently being processed.

<speech author="Shakespeare">
  To sleep, perchance to dream.
</speech>

When you call getParamNode inside the code for the speech splice, it returns the Node for the speech tag and its children. getParamNode >>= childNodes returns a list containing one TextNode containing part of Hamlet's speech. liftM (getAttribute "author") getParamNode would return Just "Shakespeare".

localParamNode :: Monad m => (Node -> Node) -> HeistT n m a -> HeistT n m a

HeistT's local.

getsHS :: Monad m => (HeistState n -> r) -> HeistT n m r

HeistT's gets.

getHS :: Monad m => HeistT n m (HeistState n)

HeistT's get.

putHS :: Monad m => HeistState n -> HeistT n m ()

HeistT's put.

modifyHS :: Monad m => (HeistState n -> HeistState n) -> HeistT n m ()

HeistT's modify.

restoreHS :: Monad m => HeistState n -> HeistT n m ()

Restores the HeistState. This function is almost like putHS except it preserves the current doctypes and splice errors. You should use this function instead of putHS to restore an old state. This was needed because doctypes needs to be in a "global scope" as opposed to the template call "local scope" of state items such as recursionDepth, curContext, and spliceMap.

localHS :: Monad m => (HeistState n -> HeistState n) -> HeistT n m a -> HeistT n m a

Abstracts the common pattern of running a HeistT computation with a modified heist state.

modRecursionDepth :: Monad m => (Int -> Int) -> HeistT n m ()

Modifies the recursion depth.

incNamespacedTags :: Monad m => HeistT n m ()

Increments the namespaced tag count

data AttAST

AST to hold attribute parsing structure. This is necessary because attoparsec doesn't support parsers running in another monad.

Constructors

Literal Text

Ident Text

Instances

Show AttAST

Defined in Heist.Internal.Types.HeistState

Methods

showsPrec :: Int -> AttAST -> ShowS

show :: AttAST -> String

showList :: [AttAST] -> ShowS

isIdent :: AttAST -> Bool

data HeistConfig m

Constructors

HeistConfig

Fields

• _hcSpliceConfig :: SpliceConfig m

  Splices and templates

• _hcNamespace :: Text

  A namespace to use for all tags that are bound to splices. Use empty string for no namespace.

• _hcErrorNotBound :: Bool

  Whether to throw an error when a tag wih the heist namespace does not correspond to a bound splice. When not using a namespace, this flag is ignored.

data SpliceConfig m

The splices and templates Heist will use. To bind a splice simply include it in the appropriate place here.

Constructors

SpliceConfig

Fields

• _scInterpretedSplices :: Splices (Splice m)

  Interpreted splices are the splices that Heist has always had. They return a list of nodes and are processed at runtime.

• _scLoadTimeSplices :: Splices (Splice IO)

  Load time splices are like interpreted splices because they return a list of nodes. But they are like compiled splices because they are processed once at load time. All of Heist's built-in splices should be used as load time splices.

• _scCompiledSplices :: Splices (Splice m)

  Compiled splices return a DList of Chunks and are processed at load time to generate a runtime monad action that will be used to render the template.

• _scAttributeSplices :: Splices (AttrSplice m)

  Attribute splices are bound to attribute names and return a list of attributes.

• _scTemplateLocations :: [TemplateLocation]

  A list of all the locations that Heist should get its templates from.

• _scCompiledTemplateFilter :: TPath -> Bool

  Predicate function to control which templates to compile. Using templates filtered out with this is still possible via callTemplate.

Instances

Semigroup (SpliceConfig m)

Defined in Heist.Internal.Types

Methods

(<>) :: SpliceConfig m -> SpliceConfig m -> SpliceConfig m

sconcat :: NonEmpty (SpliceConfig m) -> SpliceConfig m

stimes :: Integral b => b -> SpliceConfig m -> SpliceConfig m

Monoid (SpliceConfig m)

Defined in Heist.Internal.Types

Methods

mempty :: SpliceConfig m

mappend :: SpliceConfig m -> SpliceConfig m -> SpliceConfig m

mconcat :: [SpliceConfig m] -> SpliceConfig m

type TemplateLocation = IO (Either [String] TemplateRepo)

An IO action for getting a template repo from this location. By not just using a directory path here, we support templates loaded from a database, retrieved from the network, or anything else you can think of.

type TemplateRepo = HashMap TPath DocumentFile

lens :: Functor f => (t1 -> t) -> (t1 -> a -> b) -> (t -> f a) -> t1 -> f b

My lens creation function to avoid a dependency on lens.

scInterpretedSplices :: Functor f => (Splices (Splice m) -> f (Splices (Splice m))) -> SpliceConfig m -> f (SpliceConfig m)

Lens for interpreted splices :: Simple Lens (SpliceConfig m) (Splices (I.Splice m))

scLoadTimeSplices :: Functor f => (Splices (Splice IO) -> f (Splices (Splice IO))) -> SpliceConfig m -> f (SpliceConfig m)

Lens for load time splices :: Simple Lens (SpliceConfig m) (Splices (I.Splice IO))

scCompiledSplices :: Functor f => (Splices (Splice m) -> f (Splices (Splice m))) -> SpliceConfig m -> f (SpliceConfig m)

Lens for complied splices :: Simple Lens (SpliceConfig m) (Splices (C.Splice m))

scAttributeSplices :: Functor f => (Splices (AttrSplice m) -> f (Splices (AttrSplice m))) -> SpliceConfig m -> f (SpliceConfig m)

Lens for attribute splices :: Simple Lens (SpliceConfig m) (Splices (AttrSplice m))

scTemplateLocations :: Functor f => ([TemplateLocation] -> f [TemplateLocation]) -> SpliceConfig m -> f (SpliceConfig m)

Lens for template locations :: Simple Lens (SpliceConfig m) [TemplateLocation]

scCompiledTemplateFilter :: Functor f => ((TPath -> Bool) -> f (TPath -> Bool)) -> SpliceConfig m -> f (SpliceConfig m)

Lens for compiled template filter :: Simple Lens (SpliceConfig m) (TBool -> Bool)

hcSpliceConfig :: Functor f => (SpliceConfig m -> f (SpliceConfig m)) -> HeistConfig m -> f (HeistConfig m)

Lens for the SpliceConfig :: Simple Lens (HeistConfig m) (SpliceConfig m)

hcNamespace :: Functor f => (Text -> f Text) -> HeistConfig m -> f (HeistConfig m)

Lens for the namespace :: Simple Lens (HeistConfig m) Text

hcErrorNotBound :: Functor f => (Bool -> f Bool) -> HeistConfig m -> f (HeistConfig m)

Lens for the namespace error flag :: Simple Lens (HeistConfig m) Bool

hcInterpretedSplices :: Functor f => (Splices (Splice m) -> f (Splices (Splice m))) -> HeistConfig m -> f (HeistConfig m)

Lens for interpreted splices :: Simple Lens (HeistConfig m) (Splices (I.Splice m))

hcLoadTimeSplices :: Functor f => (Splices (Splice IO) -> f (Splices (Splice IO))) -> HeistConfig m -> f (HeistConfig m)

Lens for load time splices :: Simple Lens (HeistConfig m) (Splices (I.Splice IO))

hcCompiledSplices :: Functor f => (Splices (Splice m) -> f (Splices (Splice m))) -> HeistConfig m -> f (HeistConfig m)

Lens for compiled splices :: Simple Lens (HeistConfig m) (Splices (C.Splice m))

hcAttributeSplices :: Functor f => (Splices (AttrSplice m) -> f (Splices (AttrSplice m))) -> HeistConfig m -> f (HeistConfig m)

Lens for attribute splices :: Simple Lens (HeistConfig m) (Splices (AttrSplice m))

hcTemplateLocations :: Functor f => ([TemplateLocation] -> f [TemplateLocation]) -> HeistConfig m -> f (HeistConfig m)

Lens for template locations :: Simple Lens (HeistConfig m) [TemplateLocation]

hcCompiledTemplateFilter :: Functor f => ((TPath -> Bool) -> f (TPath -> Bool)) -> HeistConfig m -> f (HeistConfig m)

Lens for compiled template filter :: Simple Lens (SpliceConfig m) (TBool -> Bool)