Skip to content

User guide

Yannick Daveluy edited this page Oct 5, 2022 · 6 revisions

Installation

TODO: deploy the p2 repository on a dedicated server for installation from Eclipse or market place.

Project creation

Run the wizard from FileNewProject...XsmpXsmpcat Project and follow the instructions.

In case you installed an MDK extension, a dedicated template should be available in the template selection page.

Catalogue file

The Catalogue file is located in the smdl folder of the newly created project. Its file extension is xsmpcat.

This file is a textual file that describe the SMP Catalogue. Its content must match the Xsmpcat grammar.

The Xsmp modeler provide a specialized editor with:

  • Syntax/Semantic Coloring
  • Error Checking
  • Auto-Completion (including templates)
  • Formatting
  • Hover Information
  • Mark Occurrences
  • Go To Declaration
  • Rename Refactoring
  • Toggle Comments
  • Outline / Structure View
  • Quick Fix Proposals
  • Find References
  • Folding

Workflow

The XSMP workflow is automatic (verify that ProjectBuild Automatically is checked). This means that on each change/save of a catalogue file, the catalogue is validated and if it succedded the code generator(s) are triggered (C++ code generator for example).

Project dependencies

Project dependencies are handled by the META-INF/MANIFEST.MF file in which you can specify the list of required plug-ins.

For example, if you have a project A that requires an SMP type publicly defined in the catalogue of a project B, then you have to add in the MANIFEST.MF of the project A a dependency on the project B.

Clone this wiki locally