Changes for page Running KEITH

Last modified by Richard Kreissig on 2023/09/14 08:48
<
From version < 12.1 >
edited by Soeren Domroes
on 2019/04/01 10:58
To version < 15.1 >
edited by Soeren Domroes
on 2019/04/02 07:14
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -8,15 +8,15 @@
8 8  
9 9  For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
10 10  
11 -Use the installer go to advanced mode, add the KIELER url. Then select first pragmatics and after that semantics (that is very important).
11 +Use the installer go to advanced mode, add the KIELER url. Then select first pragmatics and after that semantics (**that is very** **important**).
12 12  
13 -Select the Theia stream for semantics and the Keith stream for pragmatics and use the latest eclipse if possible. Set the targetplatform to photon and finish.
13 +Select the Theia stream for semantics and the Keith stream for pragmatics and use the latest eclipse if possible. Set the targetplatform to photon (or latest?) and finish.
14 14  
15 15  Wait till everything installs and the setup tasks finish. If you have any problems in this stage refer to the [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
16 16  
17 17  \\
18 18  
19 -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.
19 +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.
20 20  
21 21  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//
22 22  
... ... @@ -79,11 +79,15 @@
79 79  npm install -g windows-build-tools
80 80  {{/code}}
81 81  
82 -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)
82 +This installs make, gcc, g++, python and all this. Somehow this does not really terminate. If nothing happens anymore it may be finished, just kill the process if it does not terminate.
83 83  
84 +All the installed executables are not in the path and that is okay. This is not needed since yarn/npm knows how to call them when needed.
85 +
86 +Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable||shape="rect"]].
87 +
84 84  === Known Problems in this step ===
85 85  
86 -Python is not correctly registered in the path.
90 +If python3 was already installed this may cause some problems.
87 87  
88 88  == ... on mac: ==
89 89  
... ... @@ -151,10 +151,24 @@
151 151  yarn && cd keith-app && yarn run socket
152 152  {{/code}}
153 153  
158 +//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.
159 +
154 154  Per default the KEITH opens on localhost:3000.
155 155  
156 156  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.
157 157  
164 +=== Known issues for windows: ===
165 +
166 +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.
167 +
168 +=== Known issues on mac: ===
169 +
170 +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.
171 +
172 +=== Known issues: ===
173 +
174 +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.
175 +
158 158  = Developing for KEITH =
159 159  
160 160  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:
... ... @@ -277,13 +277,13 @@
277 277   this.compilerWidget.compileInplace]) as CodeContainer
278 278  // or via a thenable
279 279  client.languageClient.then(lClient => {
280 -lClient.sendRequest("keith/kicool/compile").then((languages: LanguageDescription[]) => {
298 +lClient.sendRequest("keith/kicool/compile").then((snapshotsDescriptions: CodeContainer) => {
281 281   // very important stuff
282 282  }
283 283  // await is preferred, since it is shorter.
284 284  {{/code}}
285 285  
286 -In this example client is an instance of a language client. It is usally injected like this:
304 +In this example client is an instance of a language client. It is usually injected like this:
287 287  
288 288  {{code}}
289 289  constructor(
... ... @@ -296,6 +296,48 @@
296 296  
297 297  \\
298 298  
299 -== How to make a new ==
317 +== How to make a new package for KEITH ==
300 300  
319 +Clone the [[KEITH repository>>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]].
320 +
321 +Open the keith folder in VSCode. You are know in the keith directory in VSCode.
322 +
323 +You see something like this: TODO picture
324 +
325 +Create a new folder called keith-<your extension name>.
326 +
327 +Copy a package.json, a tslint.json, a tsconfig.json, and a src folder into the folder.
328 +
329 +Add keith-<your extension name> to workspaces in the top level package.json.
330 +
331 +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).
332 +
333 +=== What is in the src directory? ===
334 +
335 +The source directory has three optional subfolders.
336 +
337 +* 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"]].
338 +* common: Holds general helper methods, string constants and some data classes
339 +* browser: Holds all widgets, contribution for commands, menus, and widgets, and the frontend-extension.
340 +
341 +==== The frontend-extension ====
342 +
343 +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.
344 +
345 +==== More examples for stuff ====
346 +
347 +See [[Theia examples>>url:https://www.theia-ide.org/doc/Commands_Keybindings.html||shape="rect"]].
348 +
301 301  == How to write a widget ==
350 +
351 +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"]].
352 +
353 +* BaseWidget: Very basic
354 +* ReactWidget: A render method has to be implemented that redraws the widget on demand. Additionally several on* event methods can beimplemented.
355 +* TreeWidget: Extends the ReactWidget and draws the contents of the widget in a tree view.
356 +
357 +If a widget has a state it should implement the StatefulWidget interface, which allows to imlement a store and restore method.
358 +
359 +Look at examples in KEITH or Theia to see how this is done.
360 +
361 +\\
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -56852530
1 +56852536
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/56852530/Running KEITH
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/56852536/Running KEITH

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage