Why, where and how to use the Embedded Xtext Editor. Presented at XtextCON 2015 in Kiel, Germany. http://xtextcon.org/

1. Lightweight Xtext Editors
as
SWT Widgets
Moritz Eysholdt, itemis AG

2. AGENDA
• Motivation
• Use Cases
• Architecture
• API + Example

5. OnThe
Shoulders
Of
Giants

6. BUT

8. ???

9. LIGHTWEIGHT

10. Xtext Editor as WorkbenchPart
SWT Widget
syntax highlighting
live validation
content assistquick fix
quick assist
formatting
auto edit

11. USE CASES

12. RCP Dialog Properties Hover Inline More
Eclipse RCP Mail Example with exchanged message body editor

13. RCP Dialog Properties Hover Inline More
Template Proposal Editor of any Xtext Language (here: Xtend)

14. RCP Dialog Properties Hover Inline More
Xtend formatter configuration preview
read-only!

15. RCP Dialog Properties Hover Inline More
in / as properties view for a graphical editor
editable!

16. as part of hover windows
read-only!
RCP Dialog Properties Hover Inline More

17. Editing Embedded-Xtext
RCP Dialog Properties Hover Inline More
as part of diagrams
editable!

18. • Eclipse Forms
• Spread Sheet Formulas
• Data Queries
• Multi Page Editors
• Conditional Breakpoint Editor
RCP Dialog Properties Hover More

19. ARCHITECTURE

20. org.eclipse.xtext.ui.editor.embedded
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
create editor in 4 steps

21. org.eclipse.xtext.ui.editor.embedded
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
1. construct a new editor builder
create editor in 4 steps

22. org.eclipse.xtext.ui.editor.embedded
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
1. construct a new editor builder
create editor in 4 steps

23. org.eclipse.xtext.ui.editor.embedded
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
2. configuration
1. construct a new editor builder
create editor in 4 steps

24. org.eclipse.xtext.ui.editor.embedded
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
2. configuration
1. construct a new editor builder
3. create editor on SWT Composite
create editor in 4 steps

25. org.eclipse.xtext.ui.editor.embedded
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
3. create editor on SWT Composite
2. configuration
1. construct a new editor builder
create editor in 4 steps

26. org.eclipse.xtext.ui.editor.embedded
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
4. initialize document
3. create editor on SWT Composite
2. configuration
1. construct a new editor builder
create editor in 4 steps

27. org.eclipse.xtext.ui.editor.embedded
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
getEditablePart():String
updateModel(
String prefix,
String editablePart,
String suffix
)
EmbeddedEditorModelAccess
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
<< creates >>
4. initialize document
3. create editor on SWT Composite
2. configuration
1. construct a new editor builder
create editor in 4 steps

28. org.eclipse.xtext.ui.editor.embedded
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
getEditablePart():String
updateModel(
String prefix,
String editablePart,
String suffix
)
EmbeddedEditorModelAccess
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
<< creates >>
4. initialize document
3. create editor on SWT Composite
2. configuration
1. construct a new editor builder
get text,
set text
create editor in 4 steps

29. org.eclipse.xtext.ui.editor.embedded
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
getEditablePart():String
updateModel(
String prefix,
String editablePart,
String suffix
)
EmbeddedEditorModelAccess
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
<< creates >>
prefix,
editablePart,
postfix
prefix,
editablePart,
postfix

30. editor knows
viewer and document
org.eclipse.xtext.ui.editor.embedded
org.eclipse.xtext.ui.editor
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
getEditablePart():String
updateModel(
String prefix,
String editablePart,
String suffix
)
EmbeddedEditorModelAccess
XtextSourceViewer
XtextDocument
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
<< creates >>

31. org.eclipse.xtext.ui.editor.embedded
org.eclipse.xtext.ui.editor
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
getEditablePart():String
updateModel(
String prefix,
String editablePart,
String suffix
)
EmbeddedEditorModelAccess
XtextSourceViewer
XtextDocument
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
<< creates >>
document and viewer
same as in Xtext’s
WorkbenchPart-editor

32. org.eclipse.jface
text
org.eclipse.xtext.ui.editor.embedded
org.eclipse.xtext.ui.editor
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
getEditablePart():String
updateModel(
String prefix,
String editablePart,
String suffix
)
EmbeddedEditorModelAccess
XtextSourceViewer
XtextDocument
text : String
Document
Viewer
TextViewer
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
<< creates >>
Document impl
wraps text

33. org.eclipse.jface
text
org.eclipse.xtext.ui.editor.embedded
org.eclipse.xtext.ui.editor
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
getEditablePart():String
updateModel(
String prefix,
String editablePart,
String suffix
)
EmbeddedEditorModelAccess
XtextSourceViewer
XtextDocument
text : String
Document
Viewer
org.eclipse.swt.widgets
Control
TextViewer
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
<< creates >>
Viewer impl
wraps SWT Control

34. org.eclipse.jface
text
org.eclipse.xtext.ui.editor.embedded
org.eclipse.xtext.ui.editor
getViewer()
getDocument()
createPartialEditor(
String prefix,
String editablePart,
String postfix
) : EmbeddedEditorModelAccess
EmbeddedEditor
newEditor(IEditedResourceProvider) : Builder
EmbeddedEditorFactory
getEditablePart():String
updateModel(
String prefix,
String editablePart,
String suffix
)
EmbeddedEditorModelAccess
XtextSourceViewer
XtextDocument
text : String
Document
Viewer
org.eclipse.swt.widgets
Control
TextViewer
readOnly()
showErrorAndWarningAnnotations()
withResourceValidator(IResourceValidator)
withParent(Composite parent): EmbeddedEditor
Builder
<< creates >>
<< creates >>
<< creates >>

35. API / EXAMPLE

36. In the Eclipse RCP Mail Example,
change the text editor to be an Xtext editor

37. needed modifications in View.java

38. public class View extends ViewPart {
!
public void createPartControl(Composite parent) {
Composite top = new Composite(parent, SWT.NONE);
!
// ...
!
}
!
// ...
}
View.java

39. public class View extends ViewPart {
!
public void createPartControl(Composite parent) {
Composite top = new Composite(parent, SWT.NONE);
!
// ...
!
ArithmeticsActivator activator = ArithmeticsActivator.getInstance();
Injector injector = activator.getInjector(ORG_ECLIPSE_XTEXT_EXAMPLE_ARITHMETICS_ARITHMETICS);
!
!
!
!
}
!
// ...
}
View.java
obtain injector

40. public class View extends ViewPart {
!
public void createPartControl(Composite parent) {
Composite top = new Composite(parent, SWT.NONE);
!
// ...
!
ArithmeticsActivator activator = ArithmeticsActivator.getInstance();
Injector injector = activator.getInjector(ORG_ECLIPSE_XTEXT_EXAMPLE_ARITHMETICS_ARITHMETICS);
MailResourceProvider provider = injector.getInstance(MailResourceProvider.class);
EmbeddedEditorFactory factory = injector.getInstance(EmbeddedEditorFactory.class);
!
!
}
!
// ...
}
View.java
get services from injector

41. public class View extends ViewPart {
!
public void createPartControl(Composite parent) {
Composite top = new Composite(parent, SWT.NONE);
!
// ...
!
ArithmeticsActivator activator = ArithmeticsActivator.getInstance();
Injector injector = activator.getInjector(ORG_ECLIPSE_XTEXT_EXAMPLE_ARITHMETICS_ARITHMETICS);
MailResourceProvider provider = injector.getInstance(MailResourceProvider.class);
EmbeddedEditorFactory factory = injector.getInstance(EmbeddedEditorFactory.class);
EmbeddedEditor editor = factory.newEditor(provider).withParent(top);
EmbeddedEditorModelAccess model = editor.createPartialEditor("", "module HelloWorld", "", false);
}
!
// ...
}
View.java 1. create builder
2. (skipped) configure
3. create editor
4. init document

42. public class MailResourceProvider implements IEditedResourceProvider {
!
@Inject private IResourceSetProvider resourceSetProvider;
@Inject private FileExtensionProvider ext;
!
@Override
public XtextResource createResource() {
ResourceSet resourceSet = resourceSetProvider.get(null);
URI uri = URI.createURI("synthetic:/mail." + ext.getPrimaryFileExtension());
XtextResource result = (XtextResource) resourceSet.createResource(uri);
resourceSet.getResources().add(result);
return result;
}
}
Init Resource incl. ResourceSet

43. Questions?