Name Rascal/Libraries/util/IDE

Synopsis Extend an IDE with interactive, language-specific, features (Eclipse only).

Usage import util::IDE;

Details clearLanguage clearLanguages clearNonRascalContribution clearNonRascalContributions Contribution createConsole DocumentationHover ErrorMarking Folding Hyperlinking label loc Menus Outline Plugin registerAnnotator registerContributions registerLanguage registerNonRascalContributions registerOutliner

Description The IDE Meta-tooling Platform, IMP for short, is a collection of API and tools to support constructing IDEs for programming languages and domain specific languages. Using the IDE library, you can instantiate the services that IMP provides for any language implemented in Rascal.

Rascal is also a part of the collection of IMP tools and (will be) hosted shortly on eclipse.org.

To instantiate an IDE for a language implemented using Rascal, use the following steps:

• Define the grammar for the language.
• Define a parse function for the language.
• Register the language.

Now you can step-by-step extend the IDE for your language with additional features:

• clearLanguage: Clear a registered language.
• clearLanguages: Clear all registered languages.
• clearNonRascalContribution: Clear all non-Rascal IDE contributions for a specific editor.
• clearNonRascalContributions: Clear all non-Rascal IDE contributions.
• Contribution: Data type to describe contributions to the menus of the IDE.
• createConsole: Create a console with a Rascal handler.
• DocumentationHover: Show documentation strings by hovering over elements of the source text in the IDE.
• ErrorMarking: Visual and browsable error messages in the IDE.
• Folding: Editors may hide (fold) certain parts of a source text based on foldable annotations.
• Hyperlinking: Hyperlinks in source code.
• label: Annotate an outline node with a label.
• loc: Annotate an outline node with a link.
• Menus: menus in the IDE can be used to call Rascal functions with source texts as arguments and source texts as output
• Outline: An outline is an IDE view with hyperlinks that quickly visualizes an outline of a source code file
• Plugin:
• registerAnnotator: Register an annotator.
• registerContributions: Register contributions to Eclipse menus.
• registerLanguage: Register a language extension and a parser for use in Eclipse.
• registerNonRascalContributions: Register contributions to menus of a non-Rascal editor.
• registerOutliner: Register an outliner.

To be able to reuse your IDE between runs of Eclipse, read about Plugins. To add annotations to trees, just after parsing, you should register an annotator function.

Examples

rascal>import util::IDE;
ok
rascal>start syntax ABC = [a-z]+;
ok
rascal>layout Whitespace = [\ \t\n]*;
ok
rascal>start[ABC] abc(str x, loc l) { 
>>>>>>>  return parse(#start[ABC], x, l); 
>>>>>>>}
start(sort("ABC")) (str, loc): start(sort("ABC")) abc(str, loc);
rascal>registerLanguage("The ABC language", "abc", abc);
ok

After this, your current Eclipse instance will start editors for all files ending in .abc and parse them using the abc function. The editor will provide some default highlighting features.

To add annotations to trees, just after parsing, you should register an 'annotator' function:

rascal>registerAnnotator("abc", Tree (Tree t) { return t[@doc="Hello!"]; });
ok

[Edit] | [New Subconcept] | [Recompile Course] | [Warnings]