Wiki source code of Running KEITH

Version 44.1 by Niklas Rentz on 2021/10/18 12:03
Hide last authors
Soeren Domroes 40.1 1 {{layout}}
2 {{layout-section ac:type="single"}}
3 {{layout-cell}}
Soeren Domroes 6.1 4
Soeren Domroes 7.1 5
Soeren Domroes 16.1 6 {{toc maxLevel="2"/}}
Soeren Domroes 40.1 7 {{/layout-cell}}
8 {{/layout-section}}
Soeren Domroes 6.1 9
Soeren Domroes 40.1 10 {{layout-section ac:type="single"}}
11 {{layout-cell}}
Niklas Rentz 32.1 12 == Setting up your Eclipse ==
Soeren Domroes 1.1 13
Niklas Rentz 44.1 14 For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||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.
Soeren Domroes 1.1 15
Niklas Rentz 42.1 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.
Soeren Domroes 1.1 17
Niklas Rentz 42.1 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.
Soeren Domroes 1.1 19
Niklas Rentz 42.1 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.
Soeren Domroes 1.1 21
Niklas Rentz 42.1 22 Make sure that you have necessary forks of ELK/KLighD set up.
Soeren Domroes 37.1 23
Soeren Domroes 36.1 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
Niklas Rentz 42.1 27 * Select all KLighD and pragmatics plugins and do Project>Clean>Only selected and build only selected
Soeren Domroes 36.1 28 * Do the same for the semantics projects
29 * Enable Project>Build automatically
Soeren Domroes 40.1 30 {{/layout-cell}}
31 {{/layout-section}}
Soeren Domroes 36.1 32
Niklas Rentz 41.1 33 {{layout-section ac:type="single"}}
Soeren Domroes 40.1 34 {{layout-cell}}
35 == Java Application ==
36
Niklas Rentz 44.1 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>Eclipse 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
Soeren Domroes 40.1 41 To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
42
Niklas Rentz 41.1 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//.
Soeren Domroes 40.1 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 \\
Niklas Rentz 41.1 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 \\
Soeren Domroes 40.1 60 {{/layout-cell}}
61 {{/layout-section}}
62
63 {{layout-section ac:type="single"}}
64 {{layout-cell}}
Soeren Domroes 1.1 65 == Setting up a KEITH developer setup... ==
66
67 General requirements:
68
Soeren Domroes 30.1 69 * node (and additional dependencies see [[Theia developer guide>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md||shape="rect"]])
Soeren Domroes 1.1 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
Soeren Domroes 38.1 81 install node (for the version we refer to the Theia developer guide):
Soeren Domroes 1.1 82
83 {{code}}
84 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
Soeren Domroes 38.1 85 nvm install 10
Soeren Domroes 1.1 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
stu201758 43.1 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.
Soeren Domroes 1.1 107
Soeren Domroes 11.1 108 Use that to install windows-build-tools by executing the command in an administrative powershell.
Soeren Domroes 1.1 109
110 {{code}}
111 npm install -g windows-build-tools
112 {{/code}}
113
Soeren Domroes 15.1 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.
Soeren Domroes 1.1 115
Soeren Domroes 15.1 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
Soeren Domroes 14.1 118 Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable||shape="rect"]].
119
Soeren Domroes 11.1 120 === Known Problems in this step ===
121
Soeren Domroes 15.1 122 If python3 was already installed this may cause some problems.
Soeren Domroes 11.1 123
Soeren Domroes 1.1 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
Niklas Rentz 32.1 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).
Soeren Domroes 1.1 137
Soeren Domroes 5.1 138 = Stuff that may help =
Soeren Domroes 1.1 139
Soeren Domroes 35.1 140 == How to run KEITH in developer setup (socket) ==
Soeren Domroes 1.1 141
Soeren Domroes 35.1 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}}
Soeren Domroes 40.1 175 {{/layout-cell}}
176 {{/layout-section}}
Soeren Domroes 35.1 177
Niklas Rentz 41.1 178 {{layout-section ac:type="single"}}
Soeren Domroes 40.1 179 {{layout-cell}}
Niklas Rentz 41.1 180 == (% style="letter-spacing: -0.008em;" %)Running the already build LS(%%) ==
Soeren Domroes 35.1 181
Niklas Rentz 41.1 182 \\
Soeren Domroes 1.1 183
Niklas Rentz 41.1 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}}
Soeren Domroes 1.1 187
Soeren Domroes 40.1 188 \\
189
Niklas Rentz 41.1 190 Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
Soeren Domroes 40.1 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}}
Soeren Domroes 5.1 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:
Soeren Domroes 1.1 203
Soeren Domroes 5.1 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:
Soeren Domroes 1.1 205
Soeren Domroes 5.1 206 [[image:attach:image2019-2-7_17-58-22.png]]
Soeren Domroes 1.1 207
Soeren Domroes 5.1 208 Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
Soeren Domroes 3.1 209
Soeren Domroes 26.1 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}}
Soeren Domroes 1.1 220
Soeren Domroes 26.1 221 \\
222
Soeren Domroes 5.1 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}}.
Soeren Domroes 40.1 224 {{/layout-cell}}
225 {{/layout-section}}
Soeren Domroes 3.1 226
Soeren Domroes 40.1 227 {{layout-section ac:type="single"}}
228 {{layout-cell}}
Soeren Domroes 35.1 229 = Known Issues =
Soeren Domroes 3.1 230
Soeren Domroes 13.1 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
Niklas Rentz 41.1 237 //(this might already be resolved, has not been tested yet though)//
238
Soeren Domroes 13.1 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
Soeren Domroes 26.1 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}}
Soeren Domroes 13.1 245
Soeren Domroes 26.1 246 * run
247
248 {{code language="none"}}
249 yarn run rebuild:electron/browser
Soeren Domroes 29.1 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).
Soeren Domroes 26.1 259 )))
Soeren Domroes 40.1 260 {{/layout-cell}}
261 {{/layout-section}}
262 {{/layout}}

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage