HStringTemplate-0.4: StringTemplate implementation in Haskell. Source code Contents Index

Text.StringTemplate.Base

Synopsis

data StringTemplate a = STMP { senv :: SEnv a runSTMP :: SEnv a -> a } class Show a => StringTemplateShows a where stringTemplateShow :: a -> String stringTemplateFormattedShow :: String -> a -> String class ToSElem a where toSElem :: Stringable b => a -> SElem b toSElemList :: Stringable b => [a] -> SElem b type STGroup a = String -> StFirst (StringTemplate a) class Monoid a => Stringable a where 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 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 withContext :: (ToSElem a, Stringable b) => StringTemplate b -> a -> StringTemplate b optInsertTmpl :: [(String, String)] -> StringTemplate a -> StringTemplate a setEncoder :: Stringable a => (String -> String) -> StringTemplate a -> StringTemplate a paddedTrans :: a -> [[a]] -> [[a]] data SEnv a = 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

Documentation

data StringTemplate a Source

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 Source

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 Source stringTemplateFormattedShow :: String -> a -> String Source Instances StringTemplateShows Double StringTemplateShows Float StringTemplateShows LocalTime StringTemplateShows ZonedTime StringTemplateShows TimeOfDay StringTemplateShows TimeZone StringTemplateShows UTCTime StringTemplateShows Day StringTemplateShows CalendarTime StringTemplateShows TimeDiff

class ToSElem a where Source

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 Source toSElemList :: Stringable b => [a] -> SElem b Source Instances ToSElem Bool ToSElem Char ToSElem Double ToSElem Float ToSElem Int ToSElem Integer ToSElem LocalTime ToSElem ZonedTime ToSElem TimeOfDay ToSElem TimeZone ToSElem UTCTime ToSElem Day ToSElem CalendarTime ToSElem TimeDiff ToSElem a => ToSElem ([] a) Integral a => ToSElem (Ratio 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)

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

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

class Monoid a => Stringable a where Source

The Stringable class should be instantiated with care. Generally, the provided instances should be enough for anything. Methods stFromString :: String -> a Source stToString :: a -> String Source mconcatMap :: [b] -> (b -> a) -> a Source mintercalate :: a -> [a] -> a Source mlabel :: a -> a -> a Source Instances Stringable Doc Stringable ByteString Stringable ByteString Stringable ([] Char) Stringable (Endo String)

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

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

inSGen :: (STGroup a -> STGroup a) -> StringTemplate a -> StringTemplate a Source

toString :: StringTemplate String -> String Source

Renders a StringTemplate to a String.

toPPDoc :: StringTemplate Doc -> Doc Source

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

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

Generic render function for a StringTemplate of any type.

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

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 Source

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) Source

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) Source

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

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 Source

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 Source

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 Source

Adds a set of global options to a single template

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

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

data SEnv a Source

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 Source

dumpAttribs :: Stringable a => StringTemplate 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)]

Produced by Haddock version 2.3.0