|
|
|
|
Synopsis |
|
data StringTemplate a = STMP {} | | class Show a => StringTemplateShows a where | | | class ToSElem a where | | | type STGroup a = String -> StFirst (StringTemplate a) | | class Stringable a where | | | stShowsToSE :: (StringTemplateShows a, Stringable b) => a -> SElem b | | inSGen :: (STGroup a -> STGroup a) -> StringTemplate a -> StringTemplate a | | toString :: StringTemplate String -> String | | toPPDoc :: StringTemplate Doc -> Doc | | render :: Stringable a => StringTemplate a -> a | | newSTMP :: Stringable a => String -> StringTemplate a | | newAngleSTMP :: Stringable a => String -> StringTemplate a | | getStringTemplate :: Stringable a => String -> STGroup a -> Maybe (StringTemplate a) | | getStringTemplate' :: Stringable a => String -> STGroup a -> Maybe (StringTemplate a) | | setAttribute :: (ToSElem a, Stringable b) => String -> a -> StringTemplate b -> StringTemplate b | | setManyAttrib :: (ToSElem a, Stringable b) => [(String, a)] -> StringTemplate b -> StringTemplate b | | setNativeAttribute :: Stringable b => String -> b -> StringTemplate b -> StringTemplate b | | setManyNativeAttrib :: Stringable b => [(String, b)] -> StringTemplate b -> StringTemplate b | | withContext :: (ToSElem a, Stringable b) => StringTemplate b -> a -> StringTemplate b | | optInsertTmpl :: [(String, String)] -> StringTemplate a -> StringTemplate a | | setEncoder :: Stringable a => (a -> a) -> StringTemplate a -> StringTemplate a | | paddedTrans :: a -> [[a]] -> [[a]] | | data SEnv a = SEnv {} | | parseSTMP :: Stringable a => (Char, Char) -> String -> Either String (SEnv a -> a) | | dumpAttribs :: Stringable a => StringTemplate a | | checkTemplate :: Stringable a => StringTemplate a -> (Maybe String, Maybe [String], Maybe [String]) | | checkTemplateDeep :: (Stringable a, NFData a) => StringTemplate a -> ([(String, String)], [String], [String]) | | parseSTMPNames :: (Char, Char) -> String -> Either ParseError ([String], [String], [String]) |
|
|
Documentation |
|
|
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 | | Instances | |
|
|
|
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 | | Defaults to show.
| | | Defaults to _ a -> stringTemplateShow a
|
| | Instances | |
|
|
|
The ToSElem class should be instantiated for all types that can be
inserted as attributes into a StringTemplate.
| | Methods | | | Instances | ToSElem Bool | ToSElem Char | ToSElem Double | ToSElem Float | ToSElem Int | ToSElem Integer | Data a => ToSElem a | Data ToSElemD t => ToSElem t | ToSElem ByteString | ToSElem ByteString | ToSElem CalendarTime | ToSElem TimeDiff | ToSElem Text | ToSElem Text | ToSElem LocalTime | ToSElem ZonedTime | ToSElem TimeOfDay | ToSElem TimeZone | ToSElem UTCTime | ToSElem Day | ToSElem a => ToSElem [a] | Integral a => ToSElem (Ratio a) | (ToSElem a, Foldable t) => ToSElem (t a) | ToSElem a => ToSElem (Maybe a) | (ToSElem a, ToSElem b) => ToSElem (a, b) | (ToSElem a, Ix i) => ToSElem (Array i a) | ToSElem a => ToSElem (Map String a) | (ToSElem a, ToSElem b, ToSElem c) => ToSElem (a, b, c) | (ToSElem a, ToSElem b, ToSElem c, ToSElem d) => ToSElem (a, b, c, d) | (ToSElem a, ToSElem b, ToSElem c, ToSElem d, ToSElem e) => ToSElem (a, b, c, d, e) | (ToSElem a, ToSElem b, ToSElem c, ToSElem d, ToSElem e, ToSElem f) => ToSElem (a, b, c, d, e, f) | (ToSElem a, ToSElem b, ToSElem c, ToSElem d, ToSElem e, ToSElem f, ToSElem g) => ToSElem (a, b, c, d, e, f, g) | (ToSElem a, ToSElem b, ToSElem c, ToSElem d, ToSElem e, ToSElem f, ToSElem g, ToSElem h) => ToSElem (a, b, c, d, e, f, g, h) | (ToSElem a, ToSElem b, ToSElem c, ToSElem d, ToSElem e, ToSElem f, ToSElem g, ToSElem h, ToSElem i) => ToSElem (a, b, c, d, e, f, g, h, i) | (ToSElem a, ToSElem b, ToSElem c, ToSElem d, ToSElem e, ToSElem f, ToSElem g, ToSElem h, ToSElem i, ToSElem j) => ToSElem (a, b, c, d, e, f, g, h, i, j) |
|
|
|
|
A function that generates StringTemplates.
This is conceptually a query function into a "group" of StringTemplates.
|
|
class Stringable a where | Source |
|
The Stringable class should be instantiated with care.
Generally, the provided instances should be enough for anything.
| | Methods | | | | | | | mconcatMap :: [b] -> (b -> a) -> a | Source |
| Defaults to mconcatMap m k = foldr (mappend . k) mempty m
| | mintercalate :: a -> [a] -> a | Source |
| Defaults to (mconcat .) . intersperse
| | | Defaults to mlabel x y = smconcat [x, stFromString [, y, stFromString ]]
| | | Just mempty. Here to avoid orphan instances
| | | Just mappend. Here to avoid orphan instances
| | | Just mconcat. Here to avoid orphan instances
|
| | Instances | |
|
|
|
This method should be used to create ToSElem instances for
types defining a custom formatted show function.
|
|
|
|
|
Renders a StringTemplate to a String.
|
|
|
Renders a StringTemplate to a Text.PrettyPrint.HughesPJ.Doc.
|
|
|
Generic render function for a StringTemplate of any type.
|
|
|
Parses a String to produce a StringTemplate, with '$'s as delimiters.
It is constructed with a stub group that cannot look up other templates.
|
|
|
Parses a String to produce a StringTemplate, delimited by angle brackets.
It is constructed with a stub group that cannot look up other templates.
|
|
|
Queries an String Template Group and returns Just the appropriate
StringTemplate if it exists, otherwise, Nothing.
|
|
|
As with getStringTemplate but never inlined, so appropriate for use
with volatile template groups.
|
|
|
Yields a StringTemplate with the appropriate attribute set.
If the attribute already exists, it is appended to a list.
|
|
|
Yields a StringTemplate with the appropriate attributes set.
If any attribute already exists, it is appended to a list.
|
|
|
Yields a StringTemplate with the appropriate attribute set.
If the attribute already exists, it is appended to a list.
This will not translate the attribute through any intermediate
representation, so is more efficient when, e.g. setting
attributes that are large bytestrings in a bytestring template.
|
|
|
Yields a StringTemplate with the appropriate attributes set.
If any attribute already exists, it is appended to a list.
Attributes are added natively, which may provide
efficiency gains.
|
|
|
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".
|
|
|
Adds a set of global options to a single template
|
|
|
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]] | Source |
|
|
|
|
|
|
|
|
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)]
|
|
|
Returns a tuple of three Maybes. The first is set if there is a parse error in the template.
The next is set to a list of attributes that have not been set, or Nothing if all attributes are set.
The last is set to a list of invoked templates that cannot be looked up, or Nothing if all invoked templates can be found.
Note that this check is shallow -- i.e. missing attributes and templates are only caught in the top level template, not any invoked subtemplate.
|
|
|
Returns a tuple of three lists. The first is of templates with parse errors, and their erros. The next is of missing attributes, and the last is of missing templates. If there are no errors, then all lists will be empty.
|
|
|
Gets all quasiquoted names, normal names & templates used in a given template.
Must be passed a pair of chars denoting the delimeters to be used.
|
|
Produced by Haddock version 2.6.1 |