Wiki source code of Running KEITH

Version 41.1 by Niklas Rentz on 2021/03/29 08:50
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
Soeren Domroes 39.1 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.
Soeren Domroes 1.1 15
Soeren Domroes 34.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) you should select KIELER semantics for diagram only KIELER pragmatics. In any case select the keith stream.
Soeren Domroes 1.1 17
Soeren Domroes 37.1 18 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.
Soeren Domroes 1.1 19
Soeren Domroes 8.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.
Soeren Domroes 1.1 21
Soeren Domroes 37.1 22 Make sure that you have necessary forks of ELK/KlighD set up.
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
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
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
37 To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
38
Niklas Rentz 41.1 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//.
Soeren Domroes 40.1 40
41 [[image:attach:Screenshot from 2020-08-12 13-32-36.png]]
42
43 In the next step all projects that you want to include in your language server have to be added to the classpath.
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).
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 \\
Niklas Rentz 41.1 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.
54
55 \\
Soeren Domroes 40.1 56 {{/layout-cell}}
57 {{/layout-section}}
58
59 {{layout-section ac:type="single"}}
60 {{layout-cell}}
Soeren Domroes 1.1 61 == Setting up a KEITH developer setup... ==
62
63 General requirements:
64
Soeren Domroes 30.1 65 * 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 66 * npm (whatever node installs)
67 * yarn (latest version)
68 * Python (2.7.X)
69 * gcc, g++, and make (for native dependencies of some npm packages)
70 * [[Visual Studio Code>>url:https://code.visualstudio.com/||shape="rect"]] (latest version)
71 * a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository
72
73 == ... on linux: ==
74
75 (Theia has a [[guide >>url:https://www.theia-ide.org/doc/authoring_extensions||shape="rect"]]for extension development that might be helpful)
76
Soeren Domroes 38.1 77 install node (for the version we refer to the Theia developer guide):
Soeren Domroes 1.1 78
79 {{code}}
80 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
Soeren Domroes 38.1 81 nvm install 10
Soeren Domroes 1.1 82 {{/code}}
83
84 Install python if you haven't (remember: Python 2: , Python 3: ).
85
86 {{code language="none"}}
87 Install yarn (a package manager build on the package manager npm):
88 {{/code}}
89
90 {{{}}}
91
92 \\
93
94 {{code}}
95 npm install -g yarn
96 {{/code}}
97
98 \\
99
100 == ... on windows: ==
101
Soeren Domroes 38.1 102 Install [[node>>url:https://nodejs.org/download/release/v8.15.0/||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 103
Soeren Domroes 11.1 104 Use that to install windows-build-tools by executing the command in an administrative powershell.
Soeren Domroes 1.1 105
106 {{code}}
107 npm install -g windows-build-tools
108 {{/code}}
109
Soeren Domroes 15.1 110 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 111
Soeren Domroes 15.1 112 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.
113
Soeren Domroes 14.1 114 Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable||shape="rect"]].
115
Soeren Domroes 11.1 116 === Known Problems in this step ===
117
Soeren Domroes 15.1 118 If python3 was already installed this may cause some problems.
Soeren Domroes 11.1 119
Soeren Domroes 1.1 120 == ... on mac: ==
121
122 Get a package manager, something like [[brew>>url:https://brew.sh/index_de||shape="rect"]].
123
124 Use brew to install all necessary stuff.
125
126 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:
127
128 {{code}}
129 xcode-select --install
130 {{/code}}
131
Niklas Rentz 32.1 132 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 133
Soeren Domroes 5.1 134 = Stuff that may help =
Soeren Domroes 1.1 135
Soeren Domroes 35.1 136 == How to run KEITH in developer setup (socket) ==
Soeren Domroes 1.1 137
Soeren Domroes 35.1 138 Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
139
140 === Running KEITH in the browser ===
141
142 \\
143
144 {{code language="bash"}}
145 yarn && cd keith-app && yarn run socket
146 {{/code}}
147
148 //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.
149
150 Per default the KEITH opens on localhost:3000.
151
152 {{info}}
153 If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
154 {{/info}}
155
156 Run Launch in Chrome via VSCode to open a chrome browser on localhost:3000
157
158 This is necessary to be able to debug in VSCode.
159
160 === Running KEITH as (unbundled) electron app ===
161
162 {{code language="bash"}}
163 yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
164 {{/code}}
165
166 //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.
167
168 {{info}}
169 If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
170 {{/info}}
Soeren Domroes 40.1 171 {{/layout-cell}}
172 {{/layout-section}}
Soeren Domroes 35.1 173
Niklas Rentz 41.1 174 {{layout-section ac:type="single"}}
Soeren Domroes 40.1 175 {{layout-cell}}
Niklas Rentz 41.1 176 == (% style="letter-spacing: -0.008em;" %)Running the already build LS(%%) ==
Soeren Domroes 35.1 177
Niklas Rentz 41.1 178 \\
Soeren Domroes 1.1 179
Niklas Rentz 41.1 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}}
Soeren Domroes 1.1 183
Soeren Domroes 40.1 184 \\
185
Niklas Rentz 41.1 186 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 187
188 Select the language server for your OS (this will be a jar file) and run it via:
189
190 {{code}}
191 java -Dport=5007 -jar <name-of-the-jar-file>
192 {{/code}}
193 {{/layout-cell}}
194 {{/layout-section}}
195
196 {{layout-section ac:type="single"}}
197 {{layout-cell}}
Soeren Domroes 5.1 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:
Soeren Domroes 1.1 199
Soeren Domroes 5.1 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:
Soeren Domroes 1.1 201
Soeren Domroes 5.1 202 [[image:attach:image2019-2-7_17-58-22.png]]
Soeren Domroes 1.1 203
Soeren Domroes 5.1 204 Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
Soeren Domroes 3.1 205
Soeren Domroes 26.1 206 {{code language="js"}}
207 "scripts": {
208 "prepare": "yarn run clean && yarn build",
209 "clean": "theia clean",
210 "build": "theia build --mode development",
211 "start": "theia start --root-dir=../workspace",
212 "socket": "node ./src-gen/backend/main.js --root-dir=../workspace --LSP_PORT=5007 --port=3000 --loglevel=debug",
213 "watch": "theia build --watch --mode development"
214 },
215 {{/code}}
Soeren Domroes 1.1 216
Soeren Domroes 26.1 217 \\
218
Soeren Domroes 5.1 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}}.
Soeren Domroes 40.1 220 {{/layout-cell}}
221 {{/layout-section}}
Soeren Domroes 3.1 222
Soeren Domroes 40.1 223 {{layout-section ac:type="single"}}
224 {{layout-cell}}
Soeren Domroes 35.1 225 = Known Issues =
Soeren Domroes 3.1 226
Soeren Domroes 13.1 227 === Known issues for windows: ===
228
229 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.
230
231 === Known issues on mac: ===
232
Niklas Rentz 41.1 233 //(this might already be resolved, has not been tested yet though)//
234
Soeren Domroes 13.1 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
237 === Known issues: ===
238
Soeren Domroes 26.1 239 * KEITH works in the browser/electron app, but not in the electron app/browser with the following error message:(((
240 {{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 241
Soeren Domroes 26.1 242 * run
243
244 {{code language="none"}}
245 yarn run rebuild:electron/browser
Soeren Domroes 29.1 246 {{/code}} after yarn to fix this. If it does not work, delete the
247
248 {{code language="none"}}
249 node_modules
250 {{/code}} folder and try again (for browser version rebuild browser is not needed, since
251
252 {{code language="none"}}
253 yarn
254 {{/code}} already builds the correct sources).
Soeren Domroes 26.1 255 )))
Soeren Domroes 40.1 256 {{/layout-cell}}
257 {{/layout-section}}
258 {{/layout}}

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage