This document discusses requirements for developing an embedded integrated development environment (IDE) using Eclipse technologies. It describes using Eclipse Modeling Framework (EMF) to model embedded projects. It also discusses using EMF validation, Graphical Modeling Framework (GMF) editors, Xpand for code generation, and the CDT and DLTK plugins for code editing. The IDE will integrate model and code editing with compilation, communication with targets via the Target Communication Framework (TCF) and Remote System Explorer (RSE). The goal is to leverage the Eclipse ecosystem to quickly create a complex IDE environment focused on embedded development.

1. Developer Suite Use Eclipse technologiesto build a modern embedded IDE Benjamin CabéGaétan MoriceEclipseCon 2010 January 21, 2010 Sierra Wireless Proprietary and Confidential 1

2. Requirements January 21, 2010 Sierra Wireless Proprietary and Confidential 2

3. Requirements Whatis M2M ? Definition : “M2M refers to data communication between machines.” API/Web Services Connectivity Network Asset Customer Application Communication Device

6. Requirements Users profiles Newbies Solution providers Multiple targets Sierra Wireless devices Embedded Linux …

7. Technical solution January 21, 2010 Sierra Wireless Proprietary and Confidential 7

8. Editors Navigator Validation Model Editor Code Compilation Navigator Target Navigator Communication Features

9. Model Features

10. Modeling EMF - Eclipse Modeling Framework The model is the pillar of the tool Used to model what an embeddedprojectis Benefitsfrom EMF Notifications Serialization Reflective API … all the incredible EMF tools (GMF, Validation, Xpand, Ecore Tools, …)

11. Modeling

12. Navigator Model Features

13. Navigator Objectives 1:1 Mapping between Project and Model Display informations in the model as project’s artefacts

14. Navigator Workspaceintegration AdapterFactorytransforms IProjectinto Model Project Model Project intoIproject publicclassProjectAdapterFactoryimplementsIAdapterFactory{ @Override public Object getAdapter(Object adaptableObject, Class adapterType) { Object result = null; // Bi-directional adapter IProject <----> M2MProject if (adaptableObjectinstanceofIProject && adapterType.equals(Project.class)) { result = adaptToModel((IProject) adaptableObject); } elseif (adaptableObjectinstanceof Project && adapterType.equals(IProject.class)) { result = adaptIProject((Project) adaptableObject, adapterType); } returnresult; } }

15. Navigator Workspaceintegration EMF Transaction Global model repository TransactionalEditing Domain publicclassProjectActivatorextendsPlugin{ publicstaticfinal String TRANSACTIONAL_EDITING_DOMAIN_ID = "com.anwrt.ec598.project.editingDomain"; ... publicTransactionalEditingDomaingetEditingDomain(){ TransactionalEditingDomainshared = TransactionalEditingDomain.Registry.INSTANCE .getEditingDomain(TRANSACTIONAL_EDITING_DOMAIN_ID); returnshared; } ... }

16. Navigator Project Explorer Displays model objects as the Project structure Based on Common Navigator Framework Extensible treeview Rathercomplex API But reallypowerful We use an internal model to define the structure (nodesonlyused to group or display informations) Extension Points:org.eclipse.ui.navigator.* Excellent tutorial: “Building a Common Navigator based viewer”

17. Navigator Project Explorer Result

18. Editors Navigator Features Model

19. Model dition Forms editors Forms + EMF + databinding Create UI Bind UI to model privatevoidcreateContent(FormToolkittoolkit, Composite parent) { Composite composite = toolkit.createComposite(parent, SWT.NONE); GridDataFactory.fillDefaults().grab(true, false).applyTo(composite); GridLayoutFactory.fillDefaults().numColumns(2).applyTo(composite); toolkit.createLabel(composite, "Name:", SWT.NONE); _textName = toolkit.createText(composite, "", SWT.BORDER); GridDataFactory.fillDefaults().grab(true, false).applyTo(_textName); } privatevoidbind() { DataBindingContextbindingContext = newEMFDataBindingContext(); // -- Bind the Name bindingContext.bindValue(SWTObservables.observeText(_textName, SWT.FocusOut), EMFEditObservables.observeDetailValue(Realm.getDefault(), getEditingDomain(), _myEObject, M2MPackage.eINSTANCE.getINamedElement_Name())); }

20. Model edition Forms editors Result Available in PDE Incubator: EMF-FormsEditor to beused for next-generation PDE editors

21. Model edition Graphical Editor: GMF Uses GMF generator to bootstrap Heavy use of GMF Runtime Model GMF generation Generatededitor Customization Modified editor

22. Model edition Graphical Editor: GMF Otherfeatures Rotation Automatic port creation HTML Tooltips Extensible presentation Custom figures canbedefinedusing an extension point

23. Model edition Graphical Editor: GMF Result

24. Editors Navigator Validation Features Model

25. Model validation EMF Validation Extensible (needed for specific-targetconstraints) Constraints are registeredusing an extension point We use only the batch mode Extension points: org.eclipse.emf.validation.* publicIStatusvalidate (EObject model, IProgressMonitor monitor) { IBatchValidatorbatchValidator = ModelValidationService.getInstance() .newValidator(EvaluationMode.BATCH); batchValidator.setIncludeLiveConstraints(true); batchValidator.setReportSuccesses(false); returnbatchValidator.validate(model, monitor); }

26. Model validation Integrated in a builder Transparent and automatic (on save) Uses Problem Markers Coupledwith quick fixes for a better user experience

27. Editors Navigator Validation Code Features Model

28. Code generation Xpand Performance issue Workflowistoo slow then use only Java API Example of template «IMPORT model» «DEFINE file FORSourceComponentClass» «FILE project.name.toLowerCase() + "/" + name + ".java"-» package «project.name.toLowerCase()»; publicclass «name» extendsComponentClass{ «IFmethods.select(m | m.kind.toString() == "EVENT").size > 0» publicvoidreceiveEvent(intinputEventMethod,Objectvalue){ «FOREACHmethods.select(m | m.kind.toString() == "EVENT") AS m-» //TODOhandleEvent:"+ «m.name.toUpperCase()»: «ENDFOREACH-» } «ENDIF» } «ENDFILE» «ENDDEFINE»

29. Code generation Xpand Call the Xpandgeneratorprogrammatically publicvoid generate(finalEObject object, IProgressMonitor monitor) throwsCoreException { Generatorgenerator = newGenerator(); // define the metamodelused in the template MetaModel m2mMetamodel = newEmfMetaModel(M2MPackage.eINSTANCE); generator.addMetaModel(m2mMetamodel); // define the template generator.setExpand("templates::SourceComponentClass::file FOR component"); // define the output folder Outlet outlet = new Outlet("C:/myOutput/src"); generator.addOutlet(outlet); // configure protectedregions generator.setPrSrcPaths("C:/myOutput/src"); generator.setPrDefaultExcludes(true); // define the EObject input WorkflowContextDefaultImplctx = newWorkflowContextDefaultImpl(); ctx.set("component", object); // run the generator generator.invoke(ctx, newProgressMonitorAdapter(monitor), newIssuesImpl()); }

30. Code generation Integrated in a builder Transparent and automatic (on save) Synchronizationbetween model and code Incrementalgeneration

31. Editors Navigator Validation Model Editor Code Navigator Features

32. Code editors and navigator CDT Code navigation Syntaxhighlight Content assist Refactoring … LuaEclipse Based on DLTK 2

33. Code editors and navigator CDT

34. Editors Navigator Validation Model Editor Code Navigator Features

35. Round-tripping Mandatory for a good user experience Be able to edit code or model indifferently Continuoussynchronization First study: EMF Compare Good candidate but toorich for ourneeds Solution: Direct modification of existingmodels

36. Round-tripping Solution Integrated in a builder Synchronize Model and AST From code to model: Code Based on existingparser AST Java transformation Model (extractfrom code) Model (previous version) Merge Model (new version)

37. Editors Navigator Validation Model Editor Compilation Navigator Features Code

38. Compilation CDT - ManagedBuild System (MBS) Declarative creation of custom tool chains Through MBS Extension point Direct integration in CDT builder and preference A bit complex Mechanism of scanner discovery profiles to find tools binaries Extension Point: org.eclipse.ui.managebuilder.core.buildDefinition Excellent tutorial: CDT Plug-in Developer Guide Extension Point: org.eclipse.cdt.make.core.ScannerConfigurationDisccoveryProfile

39. Compilation CDT – MBS Result

40. Compilation CDT - Dependencies management Dependencies management Difficult with CDT Configuration, build artefacts, libraries include, header include to manage No generic rule => have to be hand craft Use of CDT API to access projects description Managed by refactoring process

41. Compilation CDT - Dependencies management publicclassModifyCProjectDependenciesChangeextends Change { privatefinalIProjectproject; ... public Change perform(IProgressMonitor pm) throws CoreException { ICProjectDescriptionprojectDescription = CDTPropertyManager.getProjectDescription(project); ICConfigurationDescription[] configurationDescription = projectDescription.getConfigurations(); ... } ... }

42. Editors Navigator Validation Model Editor Code Compilation Navigator Target Features

43. Features Editors Navigator Validation Model Editor Code Compilation Navigator Target Communication

44. Target communication Objectives Make device’s services available Download Terminal … De-coupling of services and communication channel Extensible January 21, 2010 Sierra Wireless Proprietary and Confidential 44

45. Target communication Target Communication Framework - TCF Embedded agent Asynchronous Protocol based on Command, Result Event Launch Config TerminalView Download Service Terminal Service Channel TCF Connection Manager Embedded Agent

46. Features Editors Navigator Validation Model Editor Code Compilation Navigator Target Navigator Communication

47. Target navigator Remote System Explorer - RSE GUI framework Tree Explorer Match well with TCF

48. Target navigator Remote System Explorer

49. Editors Navigator Validation Forms EMF Validation GMF Project Explorer + CNF Model Xpand AST Editor CDT Code Compilation CDT + DLTK Navigator TCF RSE Target Navigator Communication Features

50. Demo January 21, 2010 Sierra Wireless Proprietary and Confidential 50

51. Conclusion January 21, 2010 Sierra Wireless Proprietary and Confidential 51

52. The benefits of a large ecosystem Allows to createreallycomplexenvironmentquickly Coversdifferentskinds of domains Offersreactive support with the community Allows to focus on real added value

53. January 21, 2010 Sierra Wireless Proprietary and Confidential 53 Questions?

54. Gaétan Morice gmorice@sierrawireless.com Benjamin Cabé bcabe@sierrawireless.com