KEITH[1][2] is an IDE based on KIELER[3]. It uses KIELER as a language server to provide rich client features for SCCharts[4], Lustre, Esterel, ELK, KGraph, and some intermediary languages.
KEITH user experience is heavily influenced by VSCode, since the underlying IDE framework Theia is heavily influenced by it. The user should be able to use this tool without clicking buttons in extensive dialogs. THis influences the design and user story as described in TODO
KEITH runs in a browser. You can either start KEITH and connect to an url (i.e. localhost:3000) via a browser (this will henceforth be called the browser version of KEITH), or start an electron app with a browser that runs KEITH inside (henceforth called the electron version of KEITH). Since the electron app might use a different chromium browser some UI elements might be displayed differently, but both version work the same. The electron version is bundled via the electron-builder framework to build an appimage or an archive into the henceforth called product. Both version have two alternatives to connect to the language server (LS). KEITH can connect to the LS via a socket. This is the only way to debug the LS. In the product KEITH connects to the LS via stdio/out and has to know the relative path to the LS application.
Normally the browser version is used for debugging and the electron version is delivered as download, but both work the same and you can also use the developer tools inside the electron version to debug the application.
You can download the nightly build for the KEITH electron app and the language server here (currently no working build for MacOS).
Downloads
KEITH Nightly: https://rtsys.informatik.uni-kiel.de/~kieler/files/nightly/sccharts-integration/
KEITH Language Server: https://rtsys.informatik.uni-kiel.de/~kieler/files/nightly/sccharts-integration/
[1] Sören Domrös. Moving Model-Driven Engineering from Eclipse to Web Technologies, November 2018
[2] Niklas Rentz. Moving Transient Views from Eclipse to Web Technologies, November 2018
[3] Reinhard von Hanxleden, Hauke Fuhrmann, and Miro Spönemann. “KIELER—The KIELIntegrated Environment for Layout Eclipse Rich Client”. In:Proceedings of the Design,Automation and Test in Europe University Booth (DATE ’11). Grenoble, France, 2011.
[4] Reinhard von Hanxleden, Björn Duderstadt, Christian Motika, Steven Smyth, Michael Mendler, Joaquín Aguado, Stephen Mercer, and Owen O’Brien. SCCharts: Sequentially Constructive Statecharts for Safety-Critical Applications. In Proc. ACM SIGPLAN Conference on Programming Language Design and Implementation (PLDI’14), Edinburgh, UK, June 2014.
Using KEITH
1: Left bar, which holds the workspace. The workspace is a folder opened in the file system.
2: Left part of split main bar. It holds the file that is edited. KEITH provided rich client features for sctx, scl strl, lus, kgt, and elk files.
3: Right part of slit main bar. It holds the diagram synthesized from the current opened file.
4: Bottom bar. It holds the compiler widget. From left to right to menu bar is used to show private system, enable inplace compilation, enable autocompile on save, select compilation system via dropdown menu, and compile the active model via the selected compilation system. Below the menu all snapshots of an invoked compilation are visible. The snapshots are ordered from left to right. These snapshots are clickable and display the snapshot in the diagram view. Small snapshots indicate that these are results of the processor to the left of it. A teal color indicates that an information is attached to the snapshot. Yellow indicates a warning and red an error.
5: Right bar: holds the diagram-option widget. It is used to configure the diagram displayed in 3.
6: Main menu bar. Holds all menus.
7: Status bar: Shows status of tool including errors and warnings in workspace, current line number and column, current indentation style (here 4 Spaces), and the language in the active editor (here SCCharts). Moreover the blue color indicates that the tool has a stable connection to its language server. Yellow indicates a connection loss.
KEITH has some widgets by default, such as the problems-widget, the outline-widget, the output-widget, and the search-widget. All existing widgets are found via the View menu entry or via the command palette.
Hint
You can navigate through the snapshots via Alt+G/Alt+J
Hint
If the electron desktop app is used F1>Reload Window fixes almost anything. It is equivalent to a restart
The command palette
The command palette opens by pressing F1 or opening it via the menu View>Find Command...
The command palette can be searched commands and supports regular expressions. The displayed commands have of a name (on the left side) and optionally a shortcut to invoke them (on the right side of the command palette).
Via Ctrl+P the workspace can be searched for files to open. This can also be access via F1 and deleting the > character in the command palette.
Modeling SCCharts
See Quick Start Guide#ModelingSCCharts for details.
Overview
Content Tools