Text.StringTemplate.Base

A String with "holes" in it. StringTemplates may be composed of any Stringable type, which at the moment includes Strings, ByteStrings, PrettyPrinter Docs, and Endo Strings, which are actually of type ShowS. When a StringTemplate is composed of a type, its internals are as well, so it is, so to speak "turtles all the way down."

Constructors

STMP

senv :: SEnv a
runSTMP :: SEnv a -> a

Instances

Stringable a => SEType a (StringTemplate a)

class Show a => StringTemplateShows a where

The StringTemplateShows class should be instantiated for all types that are directly displayed in a StringTemplate, but take an optional format string. Each such type must have an appropriate ToSElem method defined as well.

Methods

stringTemplateShow :: a -> String

stringTemplateFormattedShow :: String -> a -> String

class ToSElem a where

The ToSElem class should be instantiated for all types that can be inserted as attributes into a StringTemplate.

Methods

toSElem :: Stringable b => a -> SElem b

toSElemList :: Stringable b => [a] -> SElem b

type STGroup a = String -> (StFirst (StringTemplate a))

A function that generates StringTemplates. This is conceptually a query function into a "group" of StringTemplates.

class Monoid a => Stringable a where

The Stringable class should be instantiated with care. Generally, the provided instances should be enough for anything.

Methods

stFromString :: String -> a

stToString :: a -> String

mconcatMap :: [b] -> (b -> a) -> a

mintercalate :: a -> [a] -> a

mlabel :: a -> a -> a

stShowsToSE :: (StringTemplateShows a, Stringable b) => a -> SElem b

This method should be used to create ToSElem instances for types defining a custom formatted show function.

toString :: StringTemplate String -> String

Renders a StringTemplate to a String.

toPPDoc :: StringTemplate Doc -> Doc

Renders a StringTemplate to a Text.PrettyPrint.HughesPJ.Doc.

render :: Stringable a => StringTemplate a -> a

Generic render function for a StringTemplate of any type.

newSTMP :: Stringable a => String -> StringTemplate a

Parses a String to produce a StringTemplate, with '$'s as delimiters. It is constructed with a stub group that cannot look up other templates.

newAngleSTMP :: Stringable a => String -> StringTemplate a

Parses a String to produce a StringTemplate, delimited by angle brackets. It is constructed with a stub group that cannot look up other templates.

getStringTemplate :: Stringable a => String -> STGroup a -> Maybe (StringTemplate a)

Queries an String Template Group and returns Just the appropriate StringTemplate if it exists, otherwise, Nothing.

getStringTemplate' :: Stringable a => String -> STGroup a -> Maybe (StringTemplate a)

As with getStringTemplate but never inlined, so appropriate for use with volatile template groups.

setAttribute :: (ToSElem a, Stringable b) => String -> a -> StringTemplate b -> StringTemplate b

Yields a StringTemplate with the appropriate attribute set. If the attribute already exists, it is appended to a list.

setManyAttrib :: (ToSElem a, Stringable b) => [(String, a)] -> StringTemplate b -> StringTemplate b

Yields a StringTemplate with the appropriate attributes set. If any attribute already exists, it is appended to a list.

withContext :: (ToSElem a, Stringable b) => StringTemplate b -> a -> StringTemplate b

Replaces the attributes of a StringTemplate with those described in the second argument. If the argument does not yield a set of named attributes but only a single one, that attribute is named, as a default, "it".

optInsertTmpl :: [(String, String)] -> StringTemplate a -> StringTemplate a

Adds a set of global options to a single template

setEncoder :: Stringable a => (String -> String) -> StringTemplate a -> StringTemplate a

Sets an encoding function of a template that all values are rendered with. For example one useful encoder would be Text.Html.stringToHtmlString. All attributes will be encoded once and only once.

paddedTrans :: a -> [[a]] -> [[a]]

data SEnv a

Constructors

SEnv

smp :: SMap a
sopts :: [(String, SEnv a -> SElem a)]
sgen :: STGroup a
senc :: String -> String

parseSTMP :: Stringable a => (Char, Char) -> String -> SEnv a -> a

dumpAttribs :: Stringable a => StringTemplate a

A special template that simply dumps the values of all the attributes set in it. This may be made available to any template as a function by adding it to its group. I.e. myNewGroup = addSuperGroup myGroup $ groupStringTemplates [(dumpAttribs, dumpAttribs)]

Produced by Haddock version 2.0.0.0