Skip to content
A framework to create embedded Domain-Specific Languages in Scala
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
Dsl Add keywords for perform comprehension Apr 16, 2019
compilerplugins-BangNotation Support !-notation in named arguments Apr 3, 2019
compilerplugins-ResetEverywhere
comprehension
domains-cats
domains-scalaz
domains-task Format code Mar 11, 2019
keywords-AsynchronousIo
keywords-Await Add test cases Apr 4, 2019
keywords-Catch Mark LiftFunction1CatchDsl and LiftContinuationCatchDsl as package pr… Apr 10, 2019
keywords-Continue Add keywords for perform comprehension Apr 16, 2019
keywords-Each
keywords-FlatMap
keywords-Fork Use Dsl[Catch[...], ...] as implicit parameters instead of CatchDsl[...] Apr 10, 2019
keywords-Get/src/main/scala/com/thoughtworks/dsl/keywords Improve naming Aug 28, 2018
keywords-Map
keywords-Monadic Improve Scaladoc Sep 30, 2018
keywords-NoneSafe/src/main/scala/com/thoughtworks/dsl/keywords Add NoneSafe keyword Sep 30, 2018
keywords-NullSafe Improve documentation Mar 11, 2019
keywords-Put Remove unused sbt setting Mar 31, 2019
keywords-Return Update scalatest to 3.0.6-SNAP2 Oct 5, 2018
keywords-Shift Remove workaround for scala-js/scala-js#3415 Sep 9, 2018
keywords-Using Use Dsl[Catch[...], ...] as implicit parameters instead of CatchDsl[...] Apr 10, 2019
keywords-WithFilter Add keywords for perform comprehension Apr 16, 2019
keywords-Yield Add keywords for perform comprehension Apr 16, 2019
package
project Merge pull request #232 from Atry/template Apr 11, 2019
.gitignore Merge remote-tracking branch 'remotes/origin/features/sbt-best-practi… Dec 8, 2017
.sbtopts Revert "Revert "Decrease the memory allocated for JVM"" Sep 3, 2018
.scalafmt.conf Setup Scalafmt version Mar 27, 2019
.travis.yml Merge commit 'ad6377ebc99109c9df527ec3fca2ce286708bef0' into HEAD Mar 14, 2019
LICENSE Initial commit Oct 14, 2017
README.md Update README.md Apr 4, 2019
build.sbt Add keywords for perform comprehension Apr 16, 2019
secret.sbt

README.md

Dsl.scala

Build Status Latest version Scaladoc Join the chat at https://gitter.im/ThoughtWorksInc/Dsl.scala

Dsl.scala is a framework to create embedded Domain-Specific Languages in Scala.

A DSL author is able to create language keywords by implementing the Dsl trait, which contains only one abstract method to be implemented. No knowledge about Scala compiler or AST macros is required.

DSLs written in Dsl.scala are collaborative with others DSLs and Scala control flows. A DSL user can create functions that contains interleaved DSLs implemented by different vendors, along with ordinary Scala control flows.

We also provide some built-in keywords, including:

  • The Await keyword for creating memoized asynchronous values as Scala Futures, similar to the await / async keywords in C#, Python and JavaScript.
  • The Shift keyword for creating asynchronous tasks as delimited continuations, similar to the shift operator in Scala Continuations.
  • The AsynchronousIo.Connect, AsynchronousIo.Accept, AsynchronousIo.Read and AsynchronousIo.Write keywords for performing I/O on an asynchronous channel.
  • The Yield keyword for generating lazy streams, similar to yield in C#, Python and JavaScript.
  • The Each keyword for iterating on a collection, similar to the list comprehension feature in Scala, Haskell, OCaml, Python and Lisp.
  • The Continue keyword LDK for skipping an element in a Each collection comprehension, similar to the native continue keyword in C/C++ or the mzero in Haskell.
  • The Fork keyword for duplicating current context, similar to the fork system call in POSIX.
  • The Return keyword for early returning, similar to the native return keyword in Scala.
  • The Using keyword to automatically close resources when exiting a scope, similar to the native using keyword in C#.
  • The Monadic keyword for creating Scalaz or Cats monadic control flow, similar to the !-notation in Idris.
  • The NullSafe keyword for the null safe operator, similar to the ? operator in Kotlin and Groovy.
  • The NoneSafe keyword for the None safe operator, similar to the Maybe monad in Haskell.

All the above keywords can be used together with each others. For example you can perform list comprehension to manipulate native resources in an asynchronous task by using Each, Using and Shift together.

Getting Started

Suppose you want to create a random number generator. The generated numbers should be stored in a lazily evaluated infinite stream, which can be built with the help of our built-in domain-specific keyword Yield.

So, you need to add the library that contains the implementation of the keyword Yield:

// Add the "keywords-yield" library in your build.sbt, to use the `Yield` keyword
libraryDependencies += "com.thoughtworks.dsl" %% "keywords-yield" % "latest.release"

// Add other "keywords-xxx" libraries in your build.sbt, to use other keywords
// libraryDependencies += "com.thoughtworks.dsl" %% "keywords-xxx" % "latest.release"

And the Dsl.scala compiler plug-ins that are shared by all DSLs:

// Add the following settings in your build.sbt 
addCompilerPlugin("com.thoughtworks.dsl" %% "compilerplugins-bangnotation" % "latest.release")
addCompilerPlugin("com.thoughtworks.dsl" %% "compilerplugins-reseteverywhere" % "latest.release")

The random number generator can be implemented as a recursive function that produces the next random number in each iteration.

import com.thoughtworks.dsl.keywords.Yield
// Must not annotated with @tailrec
def xorshiftRandomGenerator(seed: Int): scala.collection.immutable.Stream[Int] = {
  val tmp1 = seed ^ (seed << 13)
  val tmp2 = tmp1 ^ (tmp1 >>> 17)
  val tmp3 = tmp2 ^ (tmp2 << 5)
  !Yield(tmp3)
  xorshiftRandomGenerator(tmp3)
}

Note that a keyword is a plain case class. You need a ! prefix to the keyword to activate the DSL.

It's done. We can test it in ScalaTest:

val myGenerator = xorshiftRandomGenerator(seed = 123)
myGenerator(0) should be(31682556)
myGenerator(1) should be(-276305998)
myGenerator(2) should be(2101636938)

The call to xorshiftRandomGenerator does not throw a StackOverflowError because the execution of xorshiftRandomGenerator will be paused at the keyword Yield, and it will be resumed when the caller is looking for the next number.

Showcases

(Feel free to add your project here)

Links

You can’t perform that action at this time.