Documentation

Convenient type alies for splices.

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.

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

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

Holds data about templates read from disk.

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

Monad used for runtime splice execution.

Opaque type representing pieces of output from compiled splices.

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.

Detailed information about a splice error.

Transform a SpliceError record to a Text message.

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

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

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.

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

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

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

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

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

Helper for MonadError instance.

Helper for MonadCont instance.

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".

HeistT's local.

HeistT's gets.

HeistT's get.

HeistT's put.

HeistT's modify.

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.

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

Modifies the recursion depth.

Increments the namespaced tag count

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

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.

My lens creation function to avoid a dependency on lens.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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