Spoofax

We use the Spoofax language workbench in the lab to develop a MiniJava editor.

The Spoofax Language Workbench supports the definition of all aspects of textual languages, such as syntax, static analysis, and compilation, using high-level, declarative meta-languages. From a language definition using these meta-languages, Spoofax generates full-featured Eclipse and IntelliJ editor plugins, as well as a command-line interface. The generated editors include syntax highlighting, syntax checking, parse error recovery, error markers for syntactic and semantic errors, and custom operations, such as invoking an interpreter or compiler.

Downloading

In this lab, we will be using the Spoofax Eclipse plugin. You can download an Eclipse installation with the Spoofax Eclipse plugin preinstalled from our build farm:

• Windows 32-bits
• Windows 64-bits
• Linux 32-bits
• Linux 64-bits
• Mac OS X (Intel only)

These are specifically tagged versions of Spoofax, suited for the lab assignments. Please use these versions of Spoofax, instead of the ones found on the Spoofax website.

To install and run Spoofax, read the Installing Spoofax instructions, starting from the Unpack section.

On Windows, do not unpack the Eclipse installation into Program Files, because no write access is granted there, breaking Spoofax.

Updating

To update the Spoofax plugin in Eclipse, perform the following steps:

1. go to Help -> Install New Software…
2. in the Work with field, enter http://buildfarm.metaborg.org/job/metaborg/job/spoofax-releng/job/in4303/lastSuccessfulBuild/artifact/dist/spoofax/eclipse/site/
3. press enter and wait for the update site to load
4. press Select All
5. press Next and wait for Eclipse to calculate what to install and update
6. press Finish to download and install updates
7. when a security warning pops up, press OK to dismiss the warning
8. when Eclipse has installed all updates, it will ask for a restart, press Yes to restart Eclipse

If installation fails with errors indicating that “updates are not permitted”, it means that your Eclipse installation is in a location that requires admin rights to write files. This is the case on Windows if you’ve copied Eclipse to Program Files. Move it to a directory where you have write access, such as the desktop, to solve the problem.

Documentation

We host documentation for Spoofax and its meta-languages at spoofax.org:

• Creating a Language Project
• Language Definition with Spoofax
• Language Testing with SPT
• Syntax Definition with SDF3
• Static Semantics Definition with NaBL2
• Transformation with Stratego