Wiki source code of Running KEITH

Version 48.1 by Alexander Schulz-Rosengarten on 2023/07/11 10:24
Show last authors
1 {{layout}}
2 {{layout-section ac:type="single"}}
3 {{layout-cell}}
4
5
6 {{toc maxLevel="2"/}}
7 {{/layout-cell}}
8 {{/layout-section}}
9
10 {{layout-section ac:type="single"}}
11 {{layout-cell}}
12 == Setting up your Eclipse ==
13
14 For everything not mentioned here refer to [[Getting Eclipse>>doc:Kieler.Development.Guidelines.Getting Eclipse.WebHome||shape="rect"]] guide. Choose the 2021-06 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.
15
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.
17
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.
19
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.Development.Guidelines.Getting Eclipse.WebHome||shape="rect"]] guide or ask your advisors.
21
22 Make sure that you have necessary forks of ELK/KLighD set up.
23
24 If you have problems in the workspace that are still there after a clean build do the following:
25
26 * Disable Project>Build automatically
27 * Select all KLighD and pragmatics plugins and do Project>Clean>Only selected and build only selected
28 * Do the same for the semantics projects
29 * Enable Project>Build automatically
30 {{/layout-cell}}
31 {{/layout-section}}
32
33 {{layout-section ac:type="single"}}
34 {{layout-cell}}
35 == Java Application ==
36
37 If you have used the semantics setup, there is a pre-configured run configuration that you can use to execute the KIELER Language Server. For that, go into the **Run>[Run|Debug] Configurations>Java Application>LanguageServer with KLighD in Workspace** and execute that.
38
39 Described below is how you can set this configuration up for yourself for any manual configuration within the language server:
40
41 To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
42
43 (% 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//.
44
45 [[image:attach:Screenshot from 2020-08-12 13-32-36.png]]
46
47 In the next step all projects that you want to include in your language server have to be added to the classpath.
48
49 Go to **Classpath**, select **User Entries**,  click** Add Projects...**, and select all required projects (if you are unsure just add all of them).
50
51 Click on **Advanced**>**Add Folders** add select the project folders of all projects you added earlier.
52
53 In the **Arguments** tab make sure to add //-Dport=5007// to the **VM arguments**.
54
55 \\
56
57 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.
58
59 \\
60 {{/layout-cell}}
61 {{/layout-section}}
62
63 {{layout-section ac:type="single"}}
64 {{layout-cell}}
65 == Setting up a KEITH developer setup... ==
66
67 General requirements:
68
69 * node (and additional dependencies see [[Theia developer guide>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md||shape="rect"]])
70 * npm (whatever node installs)
71 * yarn (latest version)
72 * Python (2.7.X)
73 * gcc, g++, and make (for native dependencies of some npm packages)
74 * [[Visual Studio Code>>url:https://code.visualstudio.com/||shape="rect"]] (latest version)
75 * a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository
76
77 == ... on linux: ==
78
79 (Theia has a [[guide >>url:https://www.theia-ide.org/doc/authoring_extensions||shape="rect"]]for extension development that might be helpful)
80
81 install node (for the version we refer to the Theia developer guide):
82
83 {{code}}
84 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
85 nvm install 10
86 {{/code}}
87
88 Install python if you haven't (remember: Python 2: , Python 3: ).
89
90 {{code language="none"}}
91 Install yarn (a package manager build on the package manager npm):
92 {{/code}}
93
94 {{{}}}
95
96 \\
97
98 {{code}}
99 npm install -g yarn
100 {{/code}}
101
102 \\
103
104 == ... on windows: ==
105
106 Install [[node>>url:https://nodejs.org/download/release/latest-v10.x/||shape="rect"]] for windows. I personally used the {{code language="none"}}.msi{{/code}}. For the version refer to the Theia developer guide.
107
108 Use that to install windows-build-tools by executing the command in an administrative powershell.
109
110 {{code}}
111 npm install -g windows-build-tools
112 {{/code}}
113
114 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.
115
116 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.
117
118 Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable||shape="rect"]].
119
120 === Known Problems in this step ===
121
122 If python3 was already installed this may cause some problems.
123
124 == ... on mac: ==
125
126 Get a package manager, something like [[brew>>url:https://brew.sh/index_de||shape="rect"]].
127
128 Use brew to install all necessary stuff.
129
130 Apparently there is an issue with xcode-select: [[Theia developers>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md||shape="rect"]] recommend the following:
131
132 {{code}}
133 xcode-select --install
134 {{/code}}
135
136 After doing this for your OS all that is missing is running KEITH (in developer setup) and setting up your Eclipse for language server development).
137
138 = Stuff that may help =
139
140 == How to run KEITH in developer setup (socket) ==
141
142 Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
143
144 === Running KEITH in the browser ===
145
146 \\
147
148 {{code language="bash"}}
149 yarn && cd keith-app && yarn run socket
150 {{/code}}
151
152 //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.
153
154 Per default the KEITH opens on localhost:3000.
155
156 {{info}}
157 If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
158 {{/info}}
159
160 Run Launch in Chrome via VSCode to open a chrome browser on localhost:3000
161
162 This is necessary to be able to debug in VSCode.
163
164 === Running KEITH as (unbundled) electron app ===
165
166 {{code language="bash"}}
167 yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
168 {{/code}}
169
170 //yarn// builds all the stuff. //yarn run socket// in keith-app-electron 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-electron. Now refreshing your browser is enough to apply the changes.
171
172 {{info}}
173 If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
174 {{/info}}
175 {{/layout-cell}}
176 {{/layout-section}}
177
178 {{layout-section ac:type="single"}}
179 {{layout-cell}}
180 == (% style="letter-spacing: -0.008em;" %)Running the already build LS(%%) ==
181
182 \\
183
184 {{note}}
185 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.
186 {{/note}}
187
188 \\
189
190 Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
191
192 Select the language server for your OS (this will be a jar file) and run it via:
193
194 {{code}}
195 java -Dport=5007 -jar <name-of-the-jar-file>
196 {{/code}}
197 {{/layout-cell}}
198 {{/layout-section}}
199
200 {{layout-section ac:type="single"}}
201 {{layout-cell}}
202 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:
203
204 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:
205
206 [[image:attach:image2019-2-7_17-58-22.png]]
207
208 Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
209
210 {{code language="js"}}
211 "scripts": {
212 "prepare": "yarn run clean && yarn build",
213 "clean": "theia clean",
214 "build": "theia build --mode development",
215 "start": "theia start --root-dir=../workspace",
216 "socket": "node ./src-gen/backend/main.js --root-dir=../workspace --LSP_PORT=5007 --port=3000 --loglevel=debug",
217 "watch": "theia build --watch --mode development"
218 },
219 {{/code}}
220
221 \\
222
223 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}}.
224 {{/layout-cell}}
225 {{/layout-section}}
226
227 {{layout-section ac:type="single"}}
228 {{layout-cell}}
229 = Known Issues =
230
231 === Known issues for windows: ===
232
233 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.
234
235 === Known issues on mac: ===
236
237 //(this might already be resolved, has not been tested yet though)//
238
239 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.
240
241 === Known issues: ===
242
243 * KEITH works in the browser/electron app, but not in the electron app/browser with the following error message:(((
244 {{code language="none"}}symbol lookup error: ... symbol lookup error: .../keith/node_modules/nsfw/build/Release/nsfw.node: undefined symbol: _ZN2v816FunctionTemplate3NewEPNS_7IsolateEPFvRKNS_20FunctionCallbackInfoINS_5ValueEEEENS_5LocalIS4_EENSA_INS_9SignatureEEEiNS_19ConstructorBehaviorENS_14SideEffectTypeE {{/code}}{{code language="none"}}Done in 0.90s.{{/code}}
245
246 * run
247
248 {{code language="none"}}
249 yarn run rebuild:electron/browser
250 {{/code}} after yarn to fix this. If it does not work, delete the
251
252 {{code language="none"}}
253 node_modules
254 {{/code}} folder and try again (for browser version rebuild browser is not needed, since
255
256 {{code language="none"}}
257 yarn
258 {{/code}} already builds the correct sources).
259 )))
260 {{/layout-cell}}
261 {{/layout-section}}
262 {{/layout}}

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage