TCS/Language Project

From Eclipsepedia

Jump to: navigation, search

A TCS Language Project is an Eclipse project (typically with the ATL nature), which contains:

  • A KM3 metamodel defining the abstract syntax of the language.
  • A TCS model defining the concrete syntax of the language.
  • Optionally, such a project may also contain:
    • Constraints (e.g., in OCL, as part of an ATL transformation).
    • A compiler (e.g., in ATL, or in ACG).

This page explains how to create, and build a TCS Language Project. There are two main possibilities:

  • Using the plugin builder: this solution is simpler to use but offers fewer features (e.g., no ACG compiler, no metamodel extension). It is recommended for new TCS users to start with this solution if they do not need advanced features. It is still possible to switch to the ant-based builder later.
  • Using the ant-based builder: this solution is more complex to use but offers more features.

Contents

Creating a Language Project For Plugin Builder

This section details the steps required to create a language project for use with the plugin builder. It is necessary to install the TCS Builder plugin, and it is recommended to install the TCS Wizard plugin (information on how to build the project manually not available yet). You will need to checkout the AMMACore project in your workspace (see the corresponding section below).

Here is how to proceed:

  • Use the wizard to create a TCS Language Project: File->New->Project...->ATL->TCS Language Project.

FIACRELanguageProjectCreation-WizardSelection.png

  • Enter language information: name, and file extension.

FIACRELanguageProjectCreation-Wizard.png

  • This will create the directory structure, including sample KM3 and TCS files that need to be modified.

FIACRELanguageProjectFilesBeforeCompilation.png

  • Note that the builder is invoked during automatic builds. For instance, everything that has changed is rebuilt each time you save the KM3 or TCS file. The screenshot below shows the directory structure after a build.

FIACRELanguageProjectFilesAfterCompilation.png

Note that almost everything is done automatically with the plugin builder. This includes registration of the Textual Generic Editor (TGE) with the file extension specified for the language. However, this notably excludes registration of the megamodel. You need to right click on megamodel.xmi, and select "Add megamodel". Because megamodel registration is stored in the workspace metadata, you only need to do this once per workspace in which you use your Language Project.

Creating a Language Project For Ant-based Builder

Note: ant-based TCS builders are obsolete. You should use the plugin builder instead.

This section details the steps required to create a language project for use with the ant-based builder. Whenever the name of the language appears, we use MyLanguage.

Checking out the Required Projects

The first step is to check out the AMMAScripts, and AMMACore projects in your workspace, if you do not have them already.

To do this, you can connect anonymously by CVS to repository /cvsroot/technology on server dev.eclipse.org using the pserver protocol. Then, you can checkout the two projects available in org.eclipse.gmt/org.eclipse.gmt.tcs/scripts/.

NB: Some external libraries are required, please refer to the README.txt file in the AMMAScripts project for more details.

Creating the Directory Structure

Folder Tree sample
  • Create an ATL project:
    • Open: File->New->ATL Project
    • Name the project like your language (e.g., MyLanguage)
  • Create the following folders and files in your project:
    • MyLanguage/ (this is the project we just created)
      • Metamodel/
        • MyLanguage.km3 (you can copy and paste SampleLanguage.km3 and rename it)
      • Samples/
        • <sample programs written in your language, with the corresponding file extension>
      • Syntax/
        • MyLanguage.tcs (you can copy and paste SampleLanguage.tcs and rename it)
    • build.properties: it should contain the two paremeters showed below
    Build Properties file sample

Once you finish, your project looks like the one besides (the .externalToolBuilders/ folder is created by Eclipse)

Adding the Language Builder

Building a language involves:

  • Compiling its KM3 metamodel to Ecore.
  • Compiling its TCS model into a parser.
  • Optionally compiling its ACG compiler.

Here are the steps to follow to add the Language Builder to the project:

  • Creating the builder:
    • Right-click on your language project (e.g., MyLanguage) and select "Properties".
    • Go to the "Builders" section.
    • Click "New..."
    • Select "Ant Build"
    • Click "OK"
  • Configuring the builder:
    • Set the name of the builder to "MyLanguage Language Builder"
    • In the "Main" tab:
      • Set "Buildfile" to "${workspace_loc:/AMMAScripts/build.dsl.xml}"
      • Set "Base Directory" to "${workspace_loc:/MyLanguage}"
    Main Tab
    • In the "Targets" tab:
      • Set "During a Clean" to target "clean"
    Targets Tab
    • In the "Classpath" tab:
      • Add all the jars from the "/AMMAScripts/libs/" folder
    Classpath Tab
    • In the "JRE" tab:
      • Check "Run in the same JRE as the workspace"
    JRE Tab
    • Click "OK"
  • Set the language builder before any other builder

Launching the Injector and the Extractor

To inject (text to model) or extract (model to text) your files, you can use the following scripts as example: