Changes for page Running KEITH

Last modified by Richard Kreissig on 2023/09/14 08:48

From version < 10.1 >

edited by Soeren Domroes
on 2019/04/01 09:14

To version < 13.1 >

edited by Soeren Domroes
on 2019/04/01 13:53

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Objects (1 modified, 0 added, 0 removed)
- Confluence.Code.ConfluencePageClass[0]

Details

Page properties

Content

@@ -16,7 +16,7 @@
  \\
--The setup tasks for Modular Target will fail. Disable it after this happens and execute them again via //Help>Perform Setup Tasks//. Run //clean build//. Several pragmatics projects have error. Just close them and you will be fine.
++The setup tasks for Modular Target will fail. Disable it after this happens and execute them again via //Help>Perform Setup Tasks//. Open the //plug-in development// perspective. Select working sets as top level elements. Run //clean build//. Several pragmatics projects have errors. Just close them and you will be fine.
  To run the language server go to //Run Configurations// create a new //eclipse application// run configuration and select //Run an application//  and //de.cau.cs.kieler.language.server.LanguageServer//
@@ -73,7 +73,7 @@
  Install [[node 8>>url:https://nodejs.org/download/release/v8.15.0/||shape="rect"]] for windows. I personally used the {{code language="none"}}.msi{{/code}}.
--Use that to install windows-build-tools:
++Use that to install windows-build-tools by executing the command in an administrative powershell.
  {{code}}
  npm install -g windows-build-tools
@@ -81,6 +81,10 @@
  This installs make, gcc, g++, python and all this (I am not sure about yarn, anyway you can always install yarn the same way as in the linux description)
++=== Known Problems in this step ===
++
++Python is not correctly registered in the path.
++
  == ... on mac: ==
  Get a package manager, something like [[brew>>url:https://brew.sh/index_de||shape="rect"]].
@@ -147,10 +147,24 @@
  yarn && cd keith-app && yarn run socket
  {{/code}}
++//yarn// builds all the stuff. //yarn run socket// in keith-app starts the application. After an initial build via yarn you can run //yarn watch // to watch the changes in your repository. In another console you run yarn run socket in keith-app. Now refreshing your browser is enough to apply the changes.
++
  Per default the KEITH opens on localhost:3000.
  It is required to restart the language server if KEITH is restarted, since the diagram view has a problem (since theia-sprotty is used) to reconnect after that.
++=== Known issues for windows: ===
++
++nsfw.code not found: In the top level package.json exists a script called postinstall. Remove this on windows, delete the node_modules folder and rebuilt the application. This is a known issue of electron-builder.
++
++=== Known issues on mac: ===
++
++Since SWT is still used as part of the diagram synthesis (but is not relevant anymore). Since it is not called on the main thread this causes a deadlock. Therefore mac just does not work.
++
++=== Known issues: ===
++
++Refreshing the browser is not enough for the diagram to work. If the diagram is needed the language server has to be restarted before the browser is refreshed. This is a known issue in theia-sprotty.
++
  = Developing for KEITH =
  We use java ServiceLoader to register stuff. Here is a small example how a LanguageServerExtension is registered via a ServiceLoader and how it is used:
@@ -201,12 +201,139 @@
  de.cau.cs.kieler.kicool.ide.language.server.KiCoolLanguageServerContribution
  {{/code}}
--This
++This is the fully qualified name of the contribution written earlier.
++The language server uses all LanguageServerExtensions like this:
++
++{{code}}
++var iLanguageServerExtensions = <Object>newArrayList(languageServer) // list of all language server extensions
++for (lse : KielerServiceLoader.load(ILanguageServerContribution)) { // load all contributions
++	iLanguageServerExtensions.add(lse.getLanguageServerExtension(injector))
++}
++{{/code}}
++
++The resulting list of implementions is used to add the extensions to the language server.
++
  == Register an extension (on server side) ==
--== Register an extension (on client side) ==
++See example above for ServiceLoader and initial stuff.
--== How to send messages ==
++What is still missing are the contents of the CommandExtension implemented by the KiCoolLanguageServerExtension. This is an interface defining all additional commands. The CommandExtension looks like this.
++{{code}}
++package de.cau.cs.kieler.kicool.ide.language.server
++
++import java.util.concurrent.CompletableFuture
++import org.eclipse.lsp4j.jsonrpc.services.JsonRequest
++import org.eclipse.lsp4j.jsonrpc.services.JsonSegment
++
++/**
++ * Interface to the LSP extension commands
++ *
++ * @author really fancy name
++ *
++ */
++@JsonSegment('keith/kicool')
++interface CommandExtension {
++
++    /**
++     * Compiles file given by uri with compilationsystem given by command.
++     */
++    @JsonRequest('compile')
++    def CompletableFuture<CompilationResults> compile(String uri, String clientId, String command, boolean inplace);
++
++    /**
++     * Build diagram for snapshot with id index for file given by uri. Only works, if the file was already compiled.
++     */
++    @JsonRequest('show')
++    def CompletableFuture<String> show(String uri, String clientId, int index)
++
++    /**
++     * Returns all compilation systems which are applicable for the file at given uri.
++     *
++     * @param uri URI as string to get compilation systems for
++     * @param filter boolean indicating whether compilation systems should be filtered
++     */
++    @JsonRequest('get-systems')
++    def CompletableFuture<Object> getSystems(String uri, boolean filterSystems)
++}
++{{/code}}
++
++This defines three json-rpc commands: "keith/kicool/compile", "keith/kicool/show", "keith/kicool/get-systems". These are implemented in KiCoolLanguageServerExtension.
++
++== Register and calling an extension (on client side) ==
++
++Language server extension do not have to be registered on the client side. It is just called.
++
++You can send a request or a notification to the language server like this:
++
++{{code}}
++const lclient = await this.client.languageClient
++const snapshotsDescriptions: CodeContainer = await lclient.sendRequest("keith/kicool/compile", [uri, KeithDiagramManager.DIAGRAM_TYPE + '_sprotty', command,
++	this.compilerWidget.compileInplace]) as CodeContainer
++// or via a thenable
++client.languageClient.then(lClient => {
++lClient.sendRequest("keith/kicool/compile").then((snapshotsDescriptions: CodeContainer) => {
++	// very important stuff
++}
++// await is preferred, since it is shorter.
++{{/code}}
++
++In this example client is an instance of a language client. It is usually injected like this:
++
++{{code}}
++constructor(
++	@inject(KeithLanguageClientContribution) public readonly client: KeithLanguageClientContribution
++	// other injected classes
++    ) {
++	// constructor stuff
++}
++{{/code}}
++
++\\
++
++== How to make a new package for KEITH ==
++
++Clone the [[KEITH repository>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]].
++
++Open the keith folder in VSCode. You are know in the keith directory in VSCode.
++
++You see something like this: TODO picture
++
++Create a new folder called keith-<your extension name>.
++
++Copy a package.json, a tslint.json, a tsconfig.json, and a src folder into the folder.
++
++Add keith-<your extension name> to workspaces in the top level package.json.
++
++Add "keith-<your extension name>(% style="color: rgb(0,0,0);" %)": (%%)"0.1.0"(% style="color: rgb(0,0,0);" %) to the dependencies in the top level package.json and the product package.json files (e.g. the package.json in keith-app).
++
++=== What is in the src directory? ===
++
++The source directory has three optional subfolders.
++
++* node: Holds all backend related classes. This does currently only exist in the [[keith-language package>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse/keith-language||shape="rect"]].
++* common: Holds general helper methods, string constants and some data classes
++* browser: Holds all widgets, contribution for commands, menus, and widgets, and the frontend-extension.
++
++==== The frontend-extension ====
++
++This binds all necessary classes. Look at existing frontend extension in [[KEITH>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]] or [[Theia>>url:https://github.com/theia-ide/theia/tree/master/packages||shape="rect"]] to see how this is done.
++
++==== More examples for stuff ====
++
++See [[Theia examples>>url:https://www.theia-ide.org/doc/Commands_Keybindings.html||shape="rect"]].
++
  == How to write a widget ==
++
++There are different kinds of widgets that are commonly used in [[KEITH>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]] or in existing [[Theia packages>>url:https://github.com/theia-ide/theia/tree/master/packages||shape="rect"]].
++
++* BaseWidget: Very basic
++* ReactWidget: A render method has to be implemented that redraws the widget on demand. Additionally several on* event methods can beimplemented.
++* TreeWidget: Extends the ReactWidget and draws the contents of the widget in a tree view.
++
++If a widget has a state it should implement the StatefulWidget interface, which allows to imlement a store and restore method.
++
++Look at examples in KEITH or Theia to see how this is done.
++
++\\

Confluence.Code.ConfluencePageClass[0]

Id

@@ -1,1 +1,1 @@
--56852525
++56852532

URL

@@ -1,1 +1,1 @@
--https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/56852525/Running KEITH
++https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/56852532/Running KEITH

Changes for page Running KEITH

Summary

Details

Navigation

Quick Links