Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

Difference between revisions of "Acceleo/Interpreter"

(Expression)
(Variables)
Line 54: Line 54:
  
 
==Variables==
 
==Variables==
The variable section of the interpreter view is hidden by default, and can be shown or hidden at will through the [[Image:Acceleo Interpreter Variable action.gif]] icon of the view.
+
The variable section of the interpreter view is hidden by default, and can be shown or hidden at will through the ''[[Image:Acceleo Interpreter Variable action.gif]] Show variables'' icon of the view.
  
The variables will be displayed as a Tree, with variable names as the root, and their value(s) as children.
+
The variables will be displayed as a Tree, with variable names as the root, and their value(s) as children. They can be used in any expression with only their name :
 +
 
 +
 
 +
New variables can be created in a number of ways :
 +
 
 +
===New variable wizard===
 +
A wizard to create new primitive variables can be initiated through a right-click in the Variables view and selecting the ''New Variable'' action.
 +
[[Image:Acceleo Interpreter New Variable Start.png|center]]
 +
 
 +
The wizard itself consists of a single page that allows users to select a name for the new variable, and a primitive value (String, Boolean, Integer or Float).
 +
[[Image:Acceleo Interpreter New Variable Wizard.png|center]]
 +
 
 +
If the selected name matches that of an existing variable, the new value will be added to that existing variable's list of values.
  
 
==Feedback==
 
==Feedback==

Revision as of 04:47, 27 September 2011

Since 3.2, Acceleo offers a full-featured live request interpreter. We will focus here on detailling all of this view's possibilities.

Breakdown

First things first, what are all of these menus and fields for?

Acceleo Interpreter Breakdown.png

  1. Language selection
  2. Expression
  3. Result
  4. Variables
  5. Feedback
  6. Actions

Language selection

The title of the interpreter features a drop-down menu that allows the user to select the language of his expressions. By default, Acceleo provides the interpreter for itself, but any third-party plugin can come and add its own language to the list. More on the extension in the Extensibility section.

Expression

The expression section allows users to enter and edit expressions for the selected language. It can be fully customized by language providers and can thus become as powerful as a full-fledged editor for that language. Completion proposals and syntax highlighting are available by default for the Acceleo interpreter.

The expression will be interpreted on the fly as it is typed if the Acceleo Interpreter Realtime action.gif Real-time toggle is activated (located at the upper-right of the view, 6 in the above breakdown). Otherwise, users can call for the evaluation at any given time through either :

  • Right-click in the expression view, then hit Acceleo Interpreter Evaluate action.gif evaluate
  • Hit the Acceleo Interpreter Evaluate action.gif Evaluate icon of the expression section
  • Use the CTRL + SHIFT + D keyboard shortcut

Result

This section displays the result of evaluations in the form of a tree. There are multiple possibilities as to the result look-and-feel :

  • Collection result : each of the collection's values will be displayed as one row of the result tree.
Acceleo Interpreter Multiple result.png
  • Single object : if the result consists of a single, plain object, it will be displayed as the only row of the tree.
Acceleo Interpreter Single result.png


Each row of the tree can be displayed in a number of ways, depending on the object's type. The objects are usually displayed as they would in their own editors, but two types of generated objects are displayed in a special manner :

String

If the result is a string, its very first line will be displayed as the Tree's row.

Acceleo Interpreter Long result.png


If the string is longer than a single line, its full length can be seen in two ways :

  • Hover : Hovering the mouse over the row
Acceleo Interpreter Long result hover.png
  • Popup : Double-clicking the row
Acceleo Interpreter Long result popup.png

File

The interpreter allows you to generate "files". No file will actually be generated on disk; instead the interpreter will display them in their own special way, with the icon corresponding to their type (as known to Eclipse) and their content as a child row :

Acceleo Interpreter File result.png

A double-click on the "file" row will open a read-only editor for the file, along with all of the syntax highlighting this editor may have. (partial exemple of a "java" file opened through this action below)

Acceleo Interpreter File result readonly editor.png

Variables

The variable section of the interpreter view is hidden by default, and can be shown or hidden at will through the Acceleo Interpreter Variable action.gif Show variables icon of the view.

The variables will be displayed as a Tree, with variable names as the root, and their value(s) as children. They can be used in any expression with only their name :


New variables can be created in a number of ways :

New variable wizard

A wizard to create new primitive variables can be initiated through a right-click in the Variables view and selecting the New Variable action.

Acceleo Interpreter New Variable Start.png

The wizard itself consists of a single page that allows users to select a name for the new variable, and a primitive value (String, Boolean, Integer or Float).

Acceleo Interpreter New Variable Wizard.png

If the selected name matches that of an existing variable, the new value will be added to that existing variable's list of values.

Feedback

Actions

Extensibility


Acceleo Portal
Project Project · Installation
Features Acceleo Features · Runtime · Acceleo editor · Views & Perspective · Interpreter · Maven
User documentation Getting Started · User Guide · Acceleo operations reference · OCL operations reference · Text Production Rules · Migration From Acceleo 2.x · Best Practices · Videos · FAQ
Developer documentation Source code · How to contribute · Compatibility · MOFM2T specification · OCL specification
Community Professional Support · Report a bug

Copyright © Eclipse Foundation, Inc. All Rights Reserved.