Eclipse meets e4

Setting Up the
Development Workbench
• Copy both to your local disk:

• the right archive for your platform

• the folder material

• Hand the USB stick to the attendee next to you.

• Unzip the archive and start the included Eclipse with a
fresh workspace.

• NOTE: On Windows systems, make sure you pick a short
directory name and everything gets extracted without
errors.

meets
Developing an editor
for the e4 workbench model

Moritz Eysholdt Jan Köhnlein

Heiko Behrens

• Simplify programming
• Declarative styling / UI markup

• Uniform, pervasive platform

• Diversity of contributors

• Diversity of contributors
• Backward compatibility

Run the Demo
• Import the Contacts Demo application as a
project
• Try to run the Contacts Demo product
(fails, but creates a run conﬁg)
• Run again by means of the run conﬁguration

Workbench Modeling Tools

e4 Visual Designer

Workbench Modeling Tools

e4 Visual Designer Generic Ecore

Reference

ar
Model

m
m
ra
G

Reference

ar
Model

m
m
ra
G
Generator

Reference

ar
Model

m
m
ra
G
Generator

Runtime
Superclass

Subclass Class

ecore meta model LL(*) Parser editor

Runtime
Superclass

Subclass Class


Runtime
Superclass

Subclass Class


Model
Model
Model

Runtime
Superclass

Subclass Class


AST
Model
Model
Model

Runtime
Superclass

Subclass Class


Interpreter AST
Model
Model
Code Model
Generator

Application
Window
ToolBar
Parts

Menu

Handlers

Keybindings

Commands

Remove
commandName="Exit" description=""/> XML brackets

handlers
command="contacts.exit"
handlers
command="contacts.save"
handlers
command="contacts.delete"
handlers
command="contacts.darkTheme"
handlers
command="contacts.brightTheme"
bindings
bindings
bindings
bindings
bindings
commands
description=""
commands
Theme"
commands
description=""
commands
description=""
commands
description=""

handlers
handlers
handlers
handlers
handlers
bindings
bindings
bindings
bindings

Remove
bindings
commands
description="" UUIDs
commands
Theme"
commands
description=""
commands
description=""
commands
description=""

handlers
handlers
handlers
handlers
handlers
bindings
bindings
bindings
bindings
bindings
commands
description=""
commands
Theme"
commands
description=""
commands
description=""
commands
description=""

handlers
handlers
handlers
handlers
handlers
bindings
bindings
bindings
bindings

Remove
bindings
commands
description="" reference markup
commands
Theme"
commands
description=""
commands
description=""
commands
description=""

handlers
contacts.exit
handlers
contacts.save
handlers
contacts.delete
handlers
contacts.darkTheme
handlers
contacts.brightTheme
bindings "CTRL+D"
contacts.darkTheme
bindings "CTRL+L"
bindings "CTRL+S"
contacts.save
bindings "Delete"
contacts.delete
bindings "CTRL+5
contacts.exit
commands contacts.exit
"Exit" description=""
commands contacts.darkTheme
"Dark Theme"
commands contacts.brightTheme
"Bright description=""
commands contacts.save
"Save" description=""
commands contacts.delete
"Delete" description=""

handlers
contacts.exit
handlers
contacts.save
handlers
contacts.delete
handlers
contacts.darkTheme
handlers
bindings "CTRL+D"
contacts.darkTheme
bindings "CTRL+L"
bindings "CTRL+S"
contacts.save
bindings "Delete"

bindings
contacts.delete
"CTRL+5
Simplify
contacts.exit
Java references
"Dark Theme"

handlers
org.eclipse...ExitHandler
contacts.exit
handlers
org.eclipse...SaveHandler
contacts.save
handlers
org.eclipse...DeleteContactHandler
contacts.delete
handlers
org.eclipse...DarkThemeHandler
contacts.darkTheme
handlers
org.eclipse...BrightThemeHandler
bindings "CTRL+D"
contacts.darkTheme
bindings "CTRL+L"
bindings "CTRL+S"
contacts.save
bindings "Delete"
contacts.delete
bindings "CTRL+5
contacts.exit
"Dark Theme"

handlers
org.eclipse...ExitHandler
contacts.exit
handlers
org.eclipse...SaveHandler
contacts.save
handlers
org.eclipse...DeleteContactHandler
contacts.delete
handlers
org.eclipse...DarkThemeHandler
contacts.darkTheme
handlers
org.eclipse...BrightThemeHandler
bindings "CTRL+D"
contacts.darkTheme
bindings "CTRL+L"
bindings "CTRL+S"
contacts.save
bindings "Delete"

bindings
contacts.delete
"CTRL+5
Make it
contacts.exit
a language
"Dark Theme"

handler org.eclipse.e4.demo.contacts.handlers.ExitHandler
for contacts.exit
handler org.eclipse.e4.demo.contacts.handlers.SaveHandler
for contacts.save
handler org.eclipse.e4.demo.contacts.handlers.DarkThemeHandler
for contacts.darkTheme
handler org.eclipse.e4.demo.contacts.handlers.BrightThemeHandler
for contacts.brightTheme
handler org.eclipse.e4.demo.contacts.handlers.DeleteContactHandler
for contacts.delete

bind "CTRL+D" to contacts.darkTheme
bind "CTRL+L" to contacts.brightTheme
bind "CTRL+S" to contacts.save
bind "CTRL+5 X" to contacts.exit
bind "Delete" to contacts.delete

command contacts.exit "Exit"
command contacts.darkTheme "Dark Theme"
command contacts.brightTheme "Bright Theme"
command contacts.save "Save"
command contacts.delete "Delete"

for contacts.exit
for contacts.save
for contacts.darkTheme
for contacts.brightTheme
for contacts.delete

bind "Delete" to contacts.delete Add
command contacts.exit "Exit" namespace

application contacts
handler contacts.exit
for org.eclipse.e4.demo.contacts.handlers.ExitHandler
for exit
handler contacts.save
for org.eclipse.e4.demo.contacts.handlers.SaveHandler
for save
handler contacts.darkTheme
for org.eclipse.e4.demo.contacts.handlers.DarkThemeHandler
for darkTheme
handler contacts.brightTheme
for org.eclipse.e4.demo.contacts.handlers.BrightThemeHandler
for brightTheme
handler contacts.delete
for org.eclipse.e4.demo.contacts.handlers.DeleteContactHandler
for delete
"CTRL+D" darkTheme
"CTRL+L" brightTheme
bind "CTRL+5 X" to contacts.ex
"CTRL+S" to save
bind "CTRL+5 X" to exit
bind "Delete" to
it delete

exit
darkTheme
brightTheme
save
delete

Exercise:
A Grammar for Commands

handler org.eclipse.e4.demo.contacts.handlers.ExitHandler for exit
handler org.eclipse.e4.demo.contacts.handlers.SaveHandler for save
handler org.eclipse.e4.demo.contacts.handlers.DarkThemeHandler for darkTheme
handler org.eclipse.e4.demo.contacts.handlers.BrightThemeHandler for brightTheme
handler org.eclipse.e4.demo.contacts.handlers.DeleteContactHandler for delete

bind "CTRL+D" to darkTheme
bind "CTRL+L" to brightTheme
bind "CTRL+S" to save
bind "CTRL+5 X" to exit
bind "Delete" to delete

command exit "Exit"
command darkTheme "Dark Theme"
command brightTheme "Bright Theme"
command save "Save"
command delete "Delete"

<mainMenu xmi:id="_SeXUDu8EEd6FC9cDb6iV7g" id="_SeXUDu8EEd6FC9cDb6iV7g">
<children xsi:type="application:MenuItem"
xmi:id="_SeXUD-8EEd6FC9cDb6iV7g" id="_SeXUD-8EEd6FC9cDb6iV7g"
label="File">
<children xsi:type="application:HandledMenuItem"
xmi:id="_SeXUEO8EEd6FC9cDb6iV7g" id="_SeXUEO8EEd6FC9cDb6iV7g"
label="Save"
iconURI="platform:/plugin/org.eclipse.e4.demo.contacts/icons/silk/disk.png"
xmi:id="_SeXUEe8EEd6FC9cDb6iV7g" id="_SeXUEe8EEd6FC9cDb6iV7g"
label="Delete"
iconURI="platform:/plugin/org.eclipse.e4.demo.contacts/icons/silk/user_delete.png"
<children xsi:type="application:DirectMenuItem"
xmi:id="_SeXUEu8EEd6FC9cDb6iV7g" id="_SeXUEu8EEd6FC9cDb6iV7g"
URI="platform:/plugin/org.eclipse.e4.demo.contactsorg.eclipse.e4.demo.contacts.h...
label="Direct Exit"/>
xmi:id="_SeXUE-8EEd6FC9cDb6iV7g" id="_SeXUE-8EEd6FC9cDb6iV7g"
label="Exit"
</children>
<children xsi:type="application:MenuItem"
xmi:id="_SeXUFO8EEd6FC9cDb6iV7g" id="_SeXUFO8EEd6FC9cDb6iV7g"
label="Theme">
xmi:id="_SeXUFe8EEd6FC9cDb6iV7g" id="_SeXUFe8EEd6FC9cDb6iV7g"
label="Dark Theme"
xmi:id="_SeXUFu8EEd6FC9cDb6iV7g" id="_SeXUFu8EEd6FC9cDb6iV7g"
label="Bright Theme"
</children>
</mainMenu>

Menu {
"File" {
"Save" contacts.save icon="icons/silk/disk.png"
"Delete" contacts.delete icon="icons/silk/user_delete.png"
"Direct Exit" handler=org.eclipse.e4.demo.contacts.handlers.ExitHandler
"Exit" contacts.exit
}
"Theme" {
"Dark Theme" contacts.darkTheme
"Bright Theme" contacts.brightTheme
}
}

Exercise:
Adding the menu section

Menu {
"File" {
"Save" contacts.save icon="icons/silk/disk.png"
"Delete" contacts.delete icon="icons/ silk/user_delete.png"
"Direct Exit" handler=org.eclipse.e4.demo.contacts.handlers.ExitHandler
"Exit" contacts.exit
}
"Theme" {
"Dark Theme" contacts.darkTheme
"Bright Theme" contacts.brightTheme
}
}

command exit "Exit"
...

Cross References
...
<children xsi:type="application:PerspectiveStack"
xmi:id="_NGiG4DGjEd-zge_czUaGVQ"

UUIDs
id="_NGiG4DGjEd-zge_czUaGVQ"
selectedElement="_NGjVADGjEd-zge_czUaGVQ">
<children xsi:type="application:Perspective"
xmi:id="_NGjVADGjEd-zge_czUaGVQ"
id="_NGjVADGjEd-zge_czUaGVQ">
...

PerspectiveStack :myDslPerspectiveStack
selectedElement=myDslPerspective {

Names ...

Perspective :myDslPerspective
...

Qualiﬁed Names
1 command save "Save"

Default
QualiﬁedNameProvider

Qualiﬁed Names

qualiﬁedName( 1 )

Default

Qualiﬁed Names
1 command save "Save" EAttribute „name“

qualiﬁedName( 1 )

Default

Qualiﬁed Names

qualiﬁedName( 1 )

Default save

Qualiﬁed Names
application contacts EAttribute „name“

qualiﬁedName( 1 )

Default save

Qualiﬁed Names

qualiﬁedName( 1 )

Default contacts. save

Objects can have multiple
different names depending
on the context

application contacts 1
Scopes
command exit "Exit" 3
bind "CTRL+X" to contacts.exit

Scopes

Application Scope
name EObject
„contacts“ 1
„save“ 2
„exit“ 3

Scopes

Application Scope
name EObject
„contacts“ 1 outerScope
„save“ 2
„exit“ 3

Scopes

Application Scope File Scope
name EObject name EObject
„contacts“ 1 outerScope „contacts“ 1
„save“ 2 „contacts.save“ 2
„exit“ 3 „contacts.exit“ 3

GlobalScope
name EObject
outerScope
... all visible
FQNs
elements

GlobalScope
name EObject
outerScope
... all visible
FQNs
elements

DefaultGlobalScopeProvider

GlobalScope
name EObject
outerScope
... all visible
FQNs
elements

• all in workspace

GlobalScope
name EObject
outerScope
... all visible
FQNs
elements

• backed by an Eclipse builder

GlobalScope
name EObject
outerScope
... all visible
FQNs
elements

ResourceSetGlobalScopeProvider

GlobalScope
name EObject
outerScope
... all visible
FQNs
elements

ResourceSetGlobalScopeProvider
• all in ResourceSet

Namespace Imports
Global
name EObject
„java.util.List“ 1
„java.util.Set“ 2
„java.util.Map“ 3

Namespace Imports
Global
name EObject

Import:
Grammar 'import' importedNamespace=ImportFQN;

Namespace Imports
Global
name EObject

Import:

Model import java.util.*

Namespace Imports
Global ImportNamespaceAware
name EObject name EObject
„java.util.List“ 1 „List“ 1
outerScope
„java.util.Set“ 2 „Set“ 2
„java.util.Map“ 3 „Map“ 3

Import:

Model import java.util.*

Exercise: Java Types

import org.eclipse.e4.demo.contacts.handlers.*;

handler ExitHandler for contacts.exit

handledBy DarkThemeHandler
key "CTRL+D"
handledBy BrightThemeHandler
key "CTRL+L"
handledBy SaveHandler
key "CTRL+S"
handledBy DeleteContactHandler
key "Delete"

Dependency Injection

• Based on Google Guice


• Pervasively used in Xtext


• Invisible for clients (ex. Annotations)


• Language speciﬁc and global injectors


• Language speciﬁc and global injectors
• Makes overriding defaults easy

DI: Client Side
@Inject
private ISomeService myService;

@Inject
public MyClass(Provider<ISomeOtherService> provider) {
ISomeOtherService firstInstance = provider.get();
ISomeOtherService secondInstance = provider.get();
}

@Inject@ContentProposalLabelProvider
private ILabelProvider labelProvider;

DI: Conﬁguration
@ImplementedBy(MyServiceImpl.class)
public class IServiceInterface {
...

public class MyDeclarativeModule extends AbstractModule {
public Class<? extends IQualifiedNameProvider>
bindIQualifiedNameProvider() {
return MyQualifiedNameProvider.class;
}
...

@Singleton
public class MySingletonService extends AbstractSomeService {
...

DI: Language Modules
MyLanguage MyLanguage
RuntimeModule
bindIServiceInterface() Manual UiModule
bindIServiceInterface()
... ...

MyLanguageAbstract MyLanguageAbstract
RuntimeModule
bindIServiceInterface() Generated UiModule
... ...

Default Default
RuntimeModule
bindIServiceInterface() Defaults UiModule
... ...

AbstractModule

DI: Equinox
<plugin>
<extension point="org.eclipse.ui.editors">
<editor class=
"mydsl.MyDslExecutableExtensionFactory:org.eclipse.xtext.ui.editor.XtextEditor"
contributorClass=
"org.eclipse.ui.editors.text.TextEditorActionContributor"
default="true"
extensions="mydsl"
id="mydsl.MyDsl"
name="MyDsl Editor">
</editor>
</extension>
...

Annotations
@Fix(DomainmodelJavaValidator.INVALID_TYPE_NAME)
public void fixTypeName(final Issue issue,
IssueResolutionAcceptor acceptor) {
acceptor.accept(issue, "Capitalize name", ...

Naming
Conventions
public class MyScopeProvider
extends AbstractDeclarativeScopeProvider {

public IScope scope_Handler_command(
final Handler h, EReference rRef) {
Polymorphic ...

Dispatch
public class MyLabelProvider

Declarative
extends DefaultLabelProvider {
public String image(Command c) {
return “cmd.png“;
}

public String image(Handler c) {
... APIs

Outlook

• Improve Xtext support for
• Ecore generics
• Partial textual models
• EP org.eclipse.e4.workbench.model

Questions?

ﬁnd out more at
http://www.xtext.org
http://eclipse.org/e4

Eclipse meets e4

More Related Content

What's hot (20)

Similar to Eclipse meets e4 (20)

More from Dr. Jan Köhnlein (20)

Recently uploaded (20)

Eclipse meets e4

Editor's Notes