Summary

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

Details

Page properties

Author

...	...	@@ -1,1 +1,1 @@
1		-XWiki.nre
	1	+XWiki.sdo

Content

...	...	@@ -1,17 +1,12 @@
1		-{{layout}}
2		-{{layout-section ac:type="single"}}
3		-{{layout-cell}}
	1	+= Running KEITH =
4	4
5	5
	4	+
6	6	{{toc maxLevel="2"/}}
7		-{{/layout-cell}}
8		-{{/layout-section}}
9	9
10		-{{layout-section ac:type="single"}}
11		-{{layout-cell}}
12	12	== Setting up your Eclipse ==
13	13
14		-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.
	9	+For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
15	15
16	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) you should select KIELER semantics for diagram only KIELER pragmatics. In any case select the keith stream.
17	17
...	...	@@ -27,37 +27,29 @@
27	27	* Select all Klighd and pragmatics plugins and do Project>Clean>Only selected and build only selected
28	28	* Do the same for the semantics projects
29	29	* Enable Project>Build automatically
30		-{{/layout-cell}}
31		-{{/layout-section}}
32	32
33		-{{layout-section ac:type="single"}}
34		-{{layout-cell}}
35		-== Java Application ==
	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)
36	36
37		-To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
	28	+== [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
38	38
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//.
	30	+\\
40	40
41		-[[image:attach:Screenshot from 2020-08-12 13-32-36.png]]
	32	+You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket:
42	42
43		-In the next step all projects that you want to include in your language server have to be added to the classpath.
	34	+{{code}}
	35	+-os ${target.os} -ws ${target.ws} -arch ${target.arch} -nl ${target.nl} -consoleLog
	36	+{{/code}}
44	44
45		-Go to **Classpath**, select **User Entries**,  click** Add Projects...**, and select all required projects (if you are unsure just add all of them).
	38	+{{code}}
	39	+-Dhost=localhost -Dport=5007
	40	+{{/code}}
46	46
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		-
51	51	\\
52	52
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.
	44	+[[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
54	54
55		-\\
56		-{{/layout-cell}}
57		-{{/layout-section}}
	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.
58	58
59		-{{layout-section ac:type="single"}}
60		-{{layout-cell}}
61	61	== Setting up a KEITH developer setup... ==
62	62
63	63	General requirements:
...	...	@@ -168,33 +168,33 @@
168	168	{{info}}
169	169	If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
170	170	{{/info}}
171		-{{/layout-cell}}
172		-{{/layout-section}}
173	173
174		-{{layout-section ac:type="single"}}
175		-{{layout-cell}}
176		-== (% style="letter-spacing: -0.008em;" %)Running the already build LS(%%) ==
	159	+== Running the already build LS (you normally do not want to do this) ==
177	177
178		-\\
	161	+Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
179	179
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}}
	163	+[[image:attach:image2019-2-7_17-46-58.png]]
183	183
184		-\\
	165	+Select Language Server Zip and download the LS and unpack it somewhere.
185	185
186		-Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
	167	+Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
187	187
188		-Select the language server for your OS (this will be a jar file) and run it via:
	169	+Paste the following at the beginning of the ini-file:
189	189
	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	+
190	190	{{code}}
191		-java -Dport=5007 -jar <name-of-the-jar-file>
	182	+-Dport=5007
192	192	{{/code}}
193		-{{/layout-cell}}
194		-{{/layout-section}}
195	195
196		-{{layout-section ac:type="single"}}
197		-{{layout-cell}}
198	198	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:
199	199
200	200	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:
...	...	@@ -217,11 +217,7 @@
217	217	\\
218	218
219	219	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}}
222	222
223		-{{layout-section ac:type="single"}}
224		-{{layout-cell}}
225	225	= Known Issues =
226	226
227	227	=== Known issues for windows: ===
...	...	@@ -230,8 +230,6 @@
230	230
231	231	=== Known issues on mac: ===
232	232
233		-//(this might already be resolved, has not been tested yet though)//
234		-
235	235	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.
236	236
237	237	=== Known issues: ===
...	...	@@ -253,6 +253,5 @@
253	253	yarn
254	254	{{/code}} already builds the correct sources).
255	255	)))
256		-{{/layout-cell}}
257		-{{/layout-section}}
258		-{{/layout}}
	237	+
	238	+\\

Confluence.Code.ConfluencePageClass[0]

Id

...	...	@@ -1,1 +1,1 @@
1		-94732311
	1	+75694102

URL

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