Heist.Compiled

Compiled splices are similar to the original Heist (interpreted) splices, but without the high performance costs of traversing a DOM at runtime. Compiled splices do all of their DOM processing at load time. They are compiled to produce a runtime computation that generates a ByteString Builder. This preserves the ability to write splices that access runtime information from the HTTP request, database, etc.

If you import both this module and Heist.Interpreted in the same file, then you will need to import them qualified.

High level compiled splice API

type Splice n = HeistT n IO (DList (Chunk n))

A compiled Splice is a HeistT computation that returns a DList (Chunk m).

The more interesting part of the type signature is what comes before the return value. The first type parameter in HeistT n IO is the runtime monad. This reveals that the Chunks know about the runtime monad. The second type parameter in HeistT n IO is IO. This tells us that the compiled splices themselves are run in the IO monad, which will usually mean at load time. Compiled splices run at load time, and they return computations that run at runtime.

renderTemplate :: Monad n => HeistState n -> ByteString -> Maybe (n Builder, MIMEType)

Looks up a compiled template and returns a runtime monad computation that constructs a builder.

codeGen :: Monad n => DList (Chunk n) -> RuntimeSplice n Builder

Given a list of output chunks, consolidate turns consecutive runs of Pure Html values into maximally-efficient pre-rendered strict ByteString chunks.

runChildren :: Monad n => Splice n

Runs the parameter node's children and returns the resulting compiled chunks. By itself this function is a simple passthrough splice that makes the spliced node disappear. In combination with locally bound splices, this function makes it easier to pass the desired view into your splices.

Functions for manipulating lists of compiled splices

textSplice :: (a -> Text) -> a -> Builder

Converts a pure text splice function to a pure Builder splice function.

nodeSplice :: (a -> [Node]) -> a -> Builder

Deprecated: Use xmlNodeSplice or htmlNodeSplice, will be removed in Heist 1.1

This is the same as htmlNodeSplice.

xmlNodeSplice :: (a -> [Node]) -> a -> Builder

Converts a pure XML Node splice function to a pure Builder splice function.

htmlNodeSplice :: (a -> [Node]) -> a -> Builder

Converts a pure HTML Node splice function to a pure Builder splice function.

pureSplice :: Monad n => (a -> Builder) -> RuntimeSplice n a -> Splice n

Converts a pure Builder splice function into a monadic splice function of a RuntimeSplice.

deferMany :: (Foldable f, Monad n) => (RuntimeSplice n a -> Splice n) -> RuntimeSplice n (f a) -> Splice n

Similar to mapSplices in interpreted mode. Gets a runtime list of items and applies a compiled runtime splice function to each element of the list.

deferMap :: Monad n => (a -> RuntimeSplice n b) -> (RuntimeSplice n b -> Splice n) -> RuntimeSplice n a -> Splice n

Saves the results of a runtme computation in a Promise so they don't get recalculated if used more than once.

mayDeferMap :: Monad n => (a -> RuntimeSplice n (Maybe b)) -> (RuntimeSplice n b -> Splice n) -> RuntimeSplice n a -> Splice n

Like deferMap, but only runs the result if a Maybe function of the runtime value returns Just. If it returns Nothing, then no output is generated.

This is a good example of how to do more complex flow control with promises. The generalization of this abstraction is too complex to be distilled to elegant high-level combinators. If you need to implement your own special flow control, then you should use functions from the LowLevel module similarly to how it is done in the implementation of this function.

bindLater :: Monad n => (a -> RuntimeSplice n Builder) -> RuntimeSplice n a -> Splice n

Converts an RuntimeSplice into a Splice, given a helper function that generates a Builder.

withSplices

Arguments

:: Monad n

=> Splice n

Splice to be run

-> Splices (RuntimeSplice n a -> Splice n)

Splices to be bound first

-> RuntimeSplice n a

Runtime data needed by the above splices

-> Splice n

Runs a splice, but first binds splices given by splice functions that need some runtime data.

manyWithSplices :: (Foldable f, Monad n) => Splice n -> Splices (RuntimeSplice n a -> Splice n) -> RuntimeSplice n (f a) -> Splice n

Like withSplices, but evaluates the splice repeatedly for each element in a list generated at runtime.

withLocalSplices :: Splices (Splice n) -> Splices (AttrSplice n) -> HeistT n IO a -> HeistT n IO a

Adds a list of compiled splices to the splice map. This function is useful because it allows compiled splices to bind other compiled splices during load-time splice processing.

Constructing Chunks

The internals of the Chunk data type are deliberately not exported because we want to hide the underlying implementation as much as possible. The yield... functions give you lower level construction of DLists of Chunks.

Most of the time you will use these functions composed with return to generate a Splice. But we decided not to include the return in these functions to allow you to work with the DLists purely.

yieldPure :: Builder -> DList (Chunk n)

Yields a pure Builder known at load time. You should use this and yieldPureText as much as possible to maximize the parts of your page that can be compiled to static ByteStrings.

yieldRuntime :: RuntimeSplice n Builder -> DList (Chunk n)

Yields a runtime action that returns a builder.

yieldRuntimeEffect :: Monad n => RuntimeSplice n () -> DList (Chunk n)

Yields a runtime action that returns no value and is only needed for its side effect.

yieldPureText :: Text -> DList (Chunk n)

A convenience wrapper around yieldPure for working with Text. Roughly equivalent to textSplice from Heist.Interpreted.

yieldRuntimeText :: Monad n => RuntimeSplice n Text -> DList (Chunk n)

Convenience wrapper around yieldRuntime allowing you to work with Text.

Running nodes and splices

runNodeList :: Monad n => [Node] -> Splice n

Returns a computation that performs load-time splice processing on the supplied list of nodes.

runNode :: Monad n => Node -> Splice n

Runs a single node. If there is no splice referenced anywhere in the subtree, then it is rendered as a pure chunk, otherwise it calls compileNode to generate the appropriate runtime computation.

runAttributes

Arguments

:: Monad n

=> [(Text, Text)]

List of attributes

-> HeistT n IO [DList (Chunk n)]

Performs splice processing on a list of attributes. This is useful in situations where you need to stop recursion, but still run splice processing on the node's attributes.

runAttributesRaw

Arguments

:: Monad n

=> [(Text, Text)]

List of attributes

-> HeistT n IO (RuntimeSplice n [(Text, Text)])

Performs splice processing on a list of attributes. This is useful in situations where you need to stop recursion, but still run splice processing on the node's attributes.

callTemplate :: Monad n => ByteString -> HeistT n IO (DList (Chunk n))

Looks up a compiled template and returns a compiled splice.