Changes for page Running KEITH

Last modified by Richard Kreissig on 2023/09/14 08:48
<
From version < 39.1 >
edited by Soeren Domroes
on 2020/05/14 14:32
To version < 42.1 >
edited by Niklas Rentz
on 2021/04/26 09:01
>
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.sdo
1 +XWiki.nre
Content
... ... @@ -1,50 +1,63 @@
1 -= Running KEITH =
1 +{{layout}}
2 +{{layout-section ac:type="single"}}
3 +{{layout-cell}}
2 2  
3 3  
4 -
5 5  {{toc maxLevel="2"/}}
7 +{{/layout-cell}}
8 +{{/layout-section}}
6 6  
10 +{{layout-section ac:type="single"}}
11 +{{layout-cell}}
7 7  == Setting up your Eclipse ==
8 8  
9 -For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide. Choose the last Eclipse version and I personally recommend Eclipse for RCP & RAP developers since the Plug-In Development perspective is the default one. Another helpful perspective might be the Git perspective.
14 +For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide. Choose the 2020-06 Eclipse version (we are working on supporting the latest version again) and I personally recommend Eclipse for RCP & RAP developers since the Plug-In Development perspective is the default one. Another helpful perspective might be the Git perspective.
10 10  
11 -Use the installer go to advanced mode, add the KIELER url. If you plan to develop for the semantic language server (e.g. for the compiler) you should select KIELER semantics for diagram only KIELER pragmatics. In any case select the keith stream.
16 +Use the installer go to advanced mode, add the KIELER url. If you plan to develop for the semantic language server (e.g. for the compiler) or to work with the SCCharts language, you should select KIELER semantics; for diagram only KIELER pragmatics. In any case select the keith stream in semantics or the master stream in pragmatics.
12 12  
13 -If you plan to develop in elk at the same time first select the Eclispe Layout Kernel setup and after that either the semantics or pragmatics setup.
18 +If you plan to develop in elk at the same time first select the Eclipse Layout Kernel setup and after that either the semantics or pragmatics setup.
14 14  
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.
20 +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 or ask your advisors.
16 16  
17 -Make sure that you have necessary forks of ELK/KlighD set up.
22 +Make sure that you have necessary forks of ELK/KLighD set up.
18 18  
19 19  If you have problems in the workspace that are still there after a clean build do the following:
20 20  
21 21  * Disable Project>Build automatically
22 -* Select all Klighd and pragmatics plugins and do Project>Clean>Only selected and build only selected
27 +* Select all KLighD and pragmatics plugins and do Project>Clean>Only selected and build only selected
23 23  * Do the same for the semantics projects
24 24  * Enable Project>Build automatically
30 +{{/layout-cell}}
31 +{{/layout-section}}
25 25  
26 -To run the language server go to //Run Configurations// create a new E//clipse Application// run configuration and select //Run an application//  and //de.cau.cs.kieler.language.server.LanguageServer// (for semantics LS,//de.cau.cs.kieler.kgraph.language.server.LanguageServer// otherwise)
33 +{{layout-section ac:type="single"}}
34 +{{layout-cell}}
35 +== Java Application ==
27 27  
28 -== [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
37 +To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
29 29  
30 -\\
39 +(% style="letter-spacing: 0.0px;" %)Select the **//Project//** //de.cau.cs.kieler.language.server// or //de.cau.cs.kieler.pragmatics.language.server// and the **Main class **//de.cau.cs.kieler.language.server.LanguageServer// or //de.cau.cs.kieler.pragmatics.language.server.PragmaticsLanguageServer//.
31 31  
32 -You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket:
41 +[[image:attach:Screenshot from 2020-08-12 13-32-36.png]]
33 33  
34 -{{code}}
35 --os ${target.os} -ws ${target.ws} -arch ${target.arch} -nl ${target.nl} -consoleLog
36 -{{/code}}
43 +In the next step all projects that you want to include in your language server have to be added to the classpath.
37 37  
38 -{{code}}
39 --Dhost=localhost -Dport=5007
40 -{{/code}}
45 +Go to **Classpath**, select **User Entries**,  click** Add Projects...**, and select all required projects (if you are unsure just add all of them).
41 41  
47 +Click on **Advanced**>**Add Folders** add select the project folders of all projects you added earlier.
48 +
49 +In the **Arguments** tab make sure to add //-Dport=5007// to the **VM arguments**.
50 +
42 42  \\
43 43  
44 -[[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
53 +The default port to which KEITH tries to connect is 5007. You can of course change this for the language server but be aware that this has to be changed in KEITH too.
45 45  
46 -The default port to which KEITH tries to connect is 5007. You can of course change this for the languae server but be aware that this has to be changed in KEITH too.
55 +\\
56 +{{/layout-cell}}
57 +{{/layout-section}}
47 47  
59 +{{layout-section ac:type="single"}}
60 +{{layout-cell}}
48 48  == Setting up a KEITH developer setup... ==
49 49  
50 50  General requirements:
... ... @@ -155,33 +155,33 @@
155 155  {{info}}
156 156  If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
157 157  {{/info}}
171 +{{/layout-cell}}
172 +{{/layout-section}}
158 158  
159 -== Running the already build LS (you normally do not want to do this) ==
174 +{{layout-section ac:type="single"}}
175 +{{layout-cell}}
176 +== (% style="letter-spacing: -0.008em;" %)Running the already build LS(%%) ==
160 160  
161 -Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
178 +\\
162 162  
163 -[[image:attach:image2019-2-7_17-46-58.png]]
180 +{{note}}
181 +In the current builds, there seems to be a problem with the packaging of the jar file and executing will cause a ClassNotFoundException for org/eclipse/ui/IStorageEditorInput when initializing the LS. We are looking into this issue. For now, setup your Eclipse as described above.
182 +{{/note}}
164 164  
165 -Select Language Server Zip and download the LS and unpack it somewhere.
184 +\\
166 166  
167 -Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
186 +Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
168 168  
169 -Paste the following at the beginning of the ini-file:
188 +Select the language server for your OS (this will be a jar file) and run it via:
170 170  
171 -{{code language="bash"}}
172 --application
173 -de.cau.cs.kieler.language.server.LanguageServer
174 --noSplash
175 -{{/code}}
176 -
177 -Since an Eclipse application is built, this is needed to start the LS without a splashscreen.
178 -
179 -If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
180 -
181 181  {{code}}
182 --Dport=5007
191 +java -Dport=5007 -jar <name-of-the-jar-file>
183 183  {{/code}}
193 +{{/layout-cell}}
194 +{{/layout-section}}
184 184  
196 +{{layout-section ac:type="single"}}
197 +{{layout-cell}}
185 185  5007 is the standard port KEITH is currently connecting to in socket mode. You can find this port in your Theia application at the following location:
186 186  
187 187  Assume you are in the [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository. Go to {{code language="none"}}keith-app{{/code}}, you should see something like this:
... ... @@ -204,7 +204,11 @@
204 204  \\
205 205  
206 206  The {{code language="none"}}LSP_PORT{{/code}} option is used to activate the connection via socket. It is also possible to specify a relative location to a LS via {{code language="none"}}LS_PATH=<path to LS>{{/code}}.
220 +{{/layout-cell}}
221 +{{/layout-section}}
207 207  
223 +{{layout-section ac:type="single"}}
224 +{{layout-cell}}
208 208  = Known Issues =
209 209  
210 210  === Known issues for windows: ===
... ... @@ -213,6 +213,8 @@
213 213  
214 214  === Known issues on mac: ===
215 215  
233 +//(this might already be resolved, has not been tested yet though)//
234 +
216 216  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.
217 217  
218 218  === Known issues: ===
... ... @@ -234,5 +234,6 @@
234 234  yarn
235 235  {{/code}} already builds the correct sources).
236 236  )))
237 -
238 -\\
256 +{{/layout-cell}}
257 +{{/layout-section}}
258 +{{/layout}}
Confluence.Code.ConfluencePageClass[0]
Id
... ... @@ -1,1 +1,1 @@
1 -78675990
1 +94732318
URL
... ... @@ -1,1 +1,1 @@
1 -https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/78675990/Running KEITH
1 +https://rtsys.informatik.uni-kiel.de/confluence//wiki/spaces/KIELER/pages/94732318/Running KEITH

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage