/flinteditor-mps

Primary LanguageJetBrains MPSGNU General Public License v3.0GPL-3.0

FLINT-editor MPS

This is an experimental project exploring the viability of a visual FLINT editor based on MPS

Development

  1. Install Java 11
  2. Clone the repository
  3. Run gradlew initProject
  4. Start the ide for your specific platform. The executables are locatied in build/mps/bin

The project consists of 3 code bases

  1. MPS located in code contains the custom Flint and Lawsource language. Some helper languages can also be found in here.
  2. FlintParser located in code/java/FlintParser contains the logic for importing models and the FlintFiller.
  3. FlintSources located in code/java/FlintSources contains the logic for importing and parsing sources.

Audit

To use the audit feature add the following keys / values to the local.properties file with the values from OSS

ossindexUser=user@email.nl
ossindexToken=avalidtoken

Flint IDE

Complete IDE with all required plugins and custom branding.

Build

To build the FlintIDE run gradlew buildFlintIde. This will generate compressed artifacts in code/build/artifacts/FlintIdeDistribution.

Install

Download the latest IDE release for your OS.

Windows

The Windows asset is flint-win-ide.zip. Download and extract the zip. To start the IDE run %INSTALLATION_FOLDER%/bin/flint.bat.

Linux

he Linux asset is flint-linux-ide.tar.gz. Download and extract the tar (the command to extract a tar is tar -xf flint-linux-ide.tar.gz). To start the IDE run %INSTALLATION_FOLDER%/bin/flint.sh.

MacOS

The MacOS asset is flint-macos-ide.zip. Download and extract the zip. To start the IDE run Flint %Version%.app.

If you get a popup blocking the startup because of unknown developer.

  • Search for Security & Privacy in Finder.
  • Click the Open Anyway button.
    Open Anyway

Flint Plugin

MPS IDE, FlintPlugin and dependant plugins must be manually installed.

Build

To build the FlintIDE run gradlew buildFlintPlugin. This will generate a zip in code/build/artifacts/FlintPluginDistribution/.

Install

  1. Download and install mps 2021.2 from here
  2. Download the mbeddr platform distribution plugins zip
  3. Extract the files and folders from the com.mbeddr.platform directory in mbeddr platform-distribution.zip file to the plugins folder in your mps installation.
    • On linux (~/.MPS2021.2/config/plugins)
    • On macos (~/Library/Application Support/MPS2021.2/ or $MPS_HOME/plugins)
    • On windows (C:\Users\%USER%\.MPS2021.2\config\plugins)
  4. To install or update your flint plugin follow this guide.

Running NSX server

The editor uses http://calculemus-app.d3e4884570654486a16f.westeurope.aksapp.io/calculemus/calculemusComp/v1 as the default nsx url. To Specify a different url add a Path Variable called nsx_url to the editor. Path Variables

You can run your own version of the nsx layer by starting the docker-compose.yml file in https://ci.tno.nl/gitlab/calculemus/nsx-calculemus. Run docker-compose up -D after cloning the project.

Using Flint-mps

A user guide is available here