Data.PkgConfig.Internal.Template

Simple string template used by pkg-config.

Template

type PkgTemplate = Template

Template consists of variables and literal strings. All special characters ('$', '#', '\' and end-of-line sequences) contained in literals are escaped when serialized.

newtype Template

Template is a possibly empty sequence of fragments represented by Fragment data type.

Constructors

Template [Fragment]

Instances

Eq Template

Requires template to be converted in to lazy Text.

Data Template

Show Template

IsString Template

Generic Template

Monoid Template

Default Template

def == (mempty :: Template) === True

Typeable * Template

type Rep Template

data Fragment

Template fragment ca be either literal or variable. Literals are subject to escaping rules when serialized.

Constructors

Literal !Text

Variable !Text

Instances

Eq Fragment

Data Fragment

Generic Fragment

Typeable * Fragment

type Rep Fragment

Smart Constructors

var :: Text -> PkgTemplate

Construct variable fragment of a template.

>>> var "prefix" <> lit "/bin"
$prefix/bin

lit :: Text -> PkgTemplate

Construct literal fragment of a template. This is useful if language extension OverloadedStrings is not enabled.

>>> var "prefix" <> lit "/bin"
$prefix/bin

strLit :: String -> PkgTemplate

Create PkgTemplate literal from String by packing it in to strict Text first.

singletonLit :: Char -> PkgTemplate

Crate one character long PkgTemplate literal.

Serialize

Serialize Template

toLazyText :: Template -> Text

Serialize template in to lazy Text.

toStrictText :: Template -> Text

Serialize template in to strict Text.

toTextBuilder :: Template -> Builder

Serialize template in to Builder.

Serialize Fragment

fragmentToBuilder :: Fragment -> Builder

Serialize fragment in to Builder.

fragmentToStrictText :: Fragment -> Text

Serialize fragment in to strict Text. For literals function performs escaping of special characters.

Query Template

variables :: PkgTemplate -> [Text]

List all variables mentioned in PkgTemplate.

>>> variables $ var "foo" </> "bar" </> var "baz"
["foo","baz"]