DSL Forge is a framework for the development of domain-specific language (DSL) editors for web applications and cloud IDEs. It allows to get web-based textual editors automatically from ANTLR grammars. From the language grammar specification, JavaScript parser and lexer are automatically generated and embedded into Cloud9’s ACE editor.
The framework is composed of two features:
- Tooling for language development, and
- Runtime, or Target Components.
The Tooling has two code generators which take Xtext grammar as input and generate two variants of editors. Two generators are contributed:
- Generate ACE Editor outputs a JavaScript Parser and ACE modules from the language grammar. The generated code is packaged into a standalone HTML/JavaScript web application.
- Generate Xtext RAP Editor outputs a JavaScript parser and ACE modules from the language grammar. The generated code is packaged into an Eclipse RAP web plugin.
The Runtime is required if you develop against the Eclipse Remote Application Platform (RAP). It is a set of plugins providing services such as typed content assist, workspace management, persistency, etc. The plugins are built on top of the Basic Equinox RAP Target you can already download from the Eclipse RAP update sites.
Below the complete list of features bound by default in the generated editors:
- Syntax highlighting,
- Syntax validation,
- Content assist,
- Sever-side semantic validation,
- Scoping,
- Template proposals,
- Text hovering,
- Default Key bindings,
- Undo/Redo Support,
- Code Folding,
- Brace Matching.
- Install Eclipse The current DSL Forge version is based on Eclipse Mars packages. The packages are available under http://www.eclipse.org/downloads/packages/ To know which package is the most appropriate for you, select one of the following alternatives.
- Eclipse IDE for Java EE Developers In this scenario, users are interested in having a DSL editor shipped with HTML/JavaScript applications. The generator outputs a static web project ready to be debugged under Eclipse. The most appropriate distribution to use is Eclipse IDE for Java EE Developers as it comes with a simple HTTP Preview server easy to configure.
- Eclipse for RCP and RAP Developers If you want a closer integration with Xtext and EMF, or if you want to integrate the editor with other Eclipse components, you’d better install Eclipse for RCP and RAP Developers. This makes it possible to integrate the editor with third party RWT (Remote Widget Toolkit, the web-based SWT) plugins and widgets.
-
Install the Xtext SDK This version is using Xtext 2.8.4 (Mars). Install Xtext Complete SDK from Mars update site http://download.eclipse.org/releases/mars (Help>Install New Software).
-
Install DSL Forge Tools Use the update site http://dslforge.org/downloads/tooling/repository/
-
Setup the Target Platform There are two ways to set the target: you could either import the base target platform (may contain features you are not interested in, but everything is there to run the examples), or compose your own target platform. Import the Target Platform org.dslforge.runtime.target, open the target file (mars.target) and let P2 Provisioning System do the rest (this may take a while).
Two use cases are documented on the official websie:
- Generate ACE Editor: http://dslforge.org/getting-started-generate-ace-editor/
- Generate Xtext RAP Editor: http://dslforge.org/getting-started-generate-xtext-rap-editor/
Additional usage informationn can be found on http://dslforge.org/documentation-2/.
Also check out the live demo app http://beeone.dslforge.org/texteditor
If you still need help, feel free to drop a mail to development@dslforge.org
We actively encourage and support contributions! DSL Forge is open source, feel free to fork the repository and enhance the tool the way you want. If you think the community can benefit from your changes, please open a pull request.
DSL Forge program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0 which is available at http://www.eclipse.org/legal/epl-v10.html