31. DSLs


DSLs or Domain Specific Languages allow you to embed other languages into your Fantom source code. The syntax for a DSL is:

AnchorType <|...|>

Everything between the <| and |> tokens is considered source code of the DSL itself. The anchor type defines how to the compile the DSL. DslPlugins are registered on the anchor type, and called by the Fantom compiler to translate them into a Fantom expression.

Built-in DSLs

Fantom currently ships with these DSLs:


You can use the Str DSL to write strings which contain any character other than the "|>" sequence. They work similar to a XML CDATA section or here-documents in languages like Perl, Python, or Ruby:

echo(Str <|no \ or $ escapes need, and
           multi-line works too|>)

See the Str Literals for more details.

Regex DSL

You can use the Regex DSL to construct a Regex instance with a string pattern:

Regex <|foo|foo/(\d*)|>

You don't need to worry about escaping special characters like the backslash.


You can write your own DSLs by subclassing DslPlugin. See the RegexDslPlugin class as a simple example to get started:

class RegexDslPlugin : DslPlugin
  new make(Compiler c) : super(c) {}

  override Expr compile(DslExpr dsl)
    regexType := ns.resolveType("sys::Regex")
    fromStr := regexType.method("fromStr")
    args := [Expr.makeForLiteral(dsl.loc, ns, dsl.src)]
    return CallExpr.makeWithMethod(dsl.loc, null, fromStr, args)

// register in indexed props in build script
index = ["compiler.dsl.sys::Regex": "compiler::RegexDslPlugin"]

Note: writing plugins requires accessing the compiler APIs. This API has a very large surface area, so we cannot guarantee that these APIs won't change in the future.