Jump to: navigation, search

Difference between revisions of "Acceleo/Interpreter"

(New page: Acceleo now offers a live request interpreter {{Acceleo-index}} Category:Modeling Category:M2T Category:Acceleo)
 
(Extensibility)
(23 intermediate revisions by the same user not shown)
Line 1: Line 1:
Acceleo now offers a live request interpreter
+
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?
 +
 
 +
[[Image:Acceleo Interpreter Breakdown.png|center]]
 +
 
 +
# [[#Language selection|Language selection]]
 +
# [[#Expression|Expression]]
 +
# [[#Result|Result]]
 +
# [[#Variables|Variables]]
 +
# [[#Feedback|Feedback]]
 +
# [[#Actions|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|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 ''[[Image: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 ''[[Image:Acceleo Interpreter Evaluate action.gif]] evaluate''
 +
* Hit the ''[[Image: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.
 +
[[Image:Acceleo Interpreter Multiple result.png|center]]
 +
* Single object : if the result consists of a single, plain object, it will be displayed as the only row of the tree.
 +
[[Image:Acceleo Interpreter Single result.png|center]]
 +
 
 +
 
 +
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.
 +
[[Image:Acceleo Interpreter Long result.png|center]]
 +
 
 +
 
 +
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
 +
[[Image:Acceleo Interpreter Long result hover.png|center]]
 +
* Popup : Double-clicking the row
 +
[[Image:Acceleo Interpreter Long result popup.png|center]]
 +
 
 +
===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 :
 +
[[Image:Acceleo Interpreter File result.png|center]]
 +
 
 +
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)
 +
[[Image:Acceleo_Interpreter_File_result_readonly_editor.png|center]]
 +
 
 +
==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]] 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 :
 +
[[Image:Acceleo Interpreter Variable Sample.png|center|900x250px]]
 +
 
 +
Existing variables can be renamed or deleted through the right-click menu, or through the ''F2'' (rename) and ''del'' (delete) keyboard shortcuts.
 +
 
 +
There are two possibilities to create new variables. Either [[#Drag and Drop|drag and drop]] Objects in the viewer, or use the [[#New variable wizard|new variable wizard]].
 +
 
 +
===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.
 +
 
 +
===Drag and Drop===
 +
The variable view supports drag and drop from almost any other view, or editor. As long as the "other view" enables dragging, the variable viewer will accept the "drop" and create a new variable with the dropped element as its value. Dropped elements can be either primitives (String, integer, float...), EObjects (elements dropped from an EMF model) or plain Java Objects.
 +
 
 +
What you can do with the values of these variables, however, depends on the current interpreted language.
 +
 
 +
==Feedback==
 +
The interpreter view will use this field in order to display the various issues and information the user might need. Namely, the compilation warnings and errors if any are sprung by the current expression, evaluation warnings and errors if the compilation went fine, but the evaluation did not... and if all went well, the evaluation result's type and length.
 +
 
 +
Some examples of this include :
 +
 
 +
===Compilation errors===
 +
[[Image:Acceleo Interpreter Compilation Error.png|center|900x250px]]
 +
 
 +
===Evaluation Warning===
 +
[[Image:Acceleo Interpreter Evaluation Warning.png|center|900x250px]]
 +
 
 +
===Result===
 +
[[Image:Acceleo Interpreter Result.png|center|900x250px]]
 +
 
 +
==Actions==
 +
The toolbar of this view features a number of actions, the first part being provided by the view itself while the second half is contributed by extending language interpreters. Following is the rundown of the actions that are available by default, when the Acceleo language is selected.
 +
 
 +
===Generic actions===
 +
* ''[[Image:Acceleo Interpreter Variable action.gif]] Show variables''
 +
This toggle allows ursers to hide or display the "Variables" section of the interpreter.
 +
 
 +
* ''[[Image:Acceleo Interpreter Realtime action.gif]] Real-time''
 +
This toggle activates or disables the real-time compilation of expressions, letting the user decide when to launch evaluations or doing it on-the-fly while he types.
 +
 
 +
* ''[[Image:Acceleo Interpreter Link action.gif]] Link with editor context''
 +
This action is provided by the interpreter view itself, yet it is up to the selected language to accept the link or not. In the case of Acceleo, this action is honored if the current editor is an Acceleo editor opened on an Acceleo module.
 +
 
 +
Hitting this action when an Acceleo editor is opened links the interpreter with the opened module, enabling the user to use the queries and templates defined, imported or inherited by that module.
 +
 
 +
===Acceleo actions===
 +
* ''[[Image:Acceleo Interpreter Save expression.gif]] Save as''
 +
This action is Acceleo specific and will not be displayed for other languages. It will allow the user to save the current expression as a new template or a new query in a module of his choice.
 +
 
 +
=Changing the interpreter context=
 +
 
 +
==Linking with an editor==
 +
[PENDING]
 +
 
 +
==Working with the debugging context==
 +
[PENDING]
 +
 
 +
=Extensibility=
 +
[PENDING]
  
 
{{Acceleo-index}}
 
{{Acceleo-index}}

Revision as of 07:42, 28 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 :

Acceleo Interpreter Variable Sample.png

Existing variables can be renamed or deleted through the right-click menu, or through the F2 (rename) and del (delete) keyboard shortcuts.

There are two possibilities to create new variables. Either drag and drop Objects in the viewer, or use the new variable wizard.

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.

Drag and Drop

The variable view supports drag and drop from almost any other view, or editor. As long as the "other view" enables dragging, the variable viewer will accept the "drop" and create a new variable with the dropped element as its value. Dropped elements can be either primitives (String, integer, float...), EObjects (elements dropped from an EMF model) or plain Java Objects.

What you can do with the values of these variables, however, depends on the current interpreted language.

Feedback

The interpreter view will use this field in order to display the various issues and information the user might need. Namely, the compilation warnings and errors if any are sprung by the current expression, evaluation warnings and errors if the compilation went fine, but the evaluation did not... and if all went well, the evaluation result's type and length.

Some examples of this include :

Compilation errors

Acceleo Interpreter Compilation Error.png

Evaluation Warning

Acceleo Interpreter Evaluation Warning.png

Result

Acceleo Interpreter Result.png

Actions

The toolbar of this view features a number of actions, the first part being provided by the view itself while the second half is contributed by extending language interpreters. Following is the rundown of the actions that are available by default, when the Acceleo language is selected.

Generic actions

  • Acceleo Interpreter Variable action.gif Show variables

This toggle allows ursers to hide or display the "Variables" section of the interpreter.

  • Acceleo Interpreter Realtime action.gif Real-time

This toggle activates or disables the real-time compilation of expressions, letting the user decide when to launch evaluations or doing it on-the-fly while he types.

  • Acceleo Interpreter Link action.gif Link with editor context

This action is provided by the interpreter view itself, yet it is up to the selected language to accept the link or not. In the case of Acceleo, this action is honored if the current editor is an Acceleo editor opened on an Acceleo module.

Hitting this action when an Acceleo editor is opened links the interpreter with the opened module, enabling the user to use the queries and templates defined, imported or inherited by that module.

Acceleo actions

  • Acceleo Interpreter Save expression.gif Save as

This action is Acceleo specific and will not be displayed for other languages. It will allow the user to save the current expression as a new template or a new query in a module of his choice.

Changing the interpreter context

Linking with an editor

[PENDING]

Working with the debugging context

[PENDING]

Extensibility

[PENDING]


Acceleo Portal
Project Project · Installation · New & noteworthy · Release review · API policy · Retention policy · Next · Checklist
Features Acceleo Features · Runtime · Acceleo editor · Views & Perspective · Debugger · Profiler · Traceability · Wishlist · Interpreter · Maven
User documentation Getting Started · 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 Conferences · Twitter & Blogs · Professional Support · Report a bug