Wiki source code of Running KEITH

Version 42.1 by Niklas Rentz on 2021/04/26 09:01
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.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.
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.Getting Eclipse||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 To run the language server go to //Run Configurations// create a new //Java Application// run configuration.
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//.
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 \\
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 \\
56 {{/layout-cell}}
57 {{/layout-section}}
58
59 {{layout-section ac:type="single"}}
60 {{layout-cell}}
61 == Setting up a KEITH developer setup... ==
62
63 General requirements:
64
65 * node (and additional dependencies see [[Theia developer guide>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md||shape="rect"]])
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
77 install node (for the version we refer to the Theia developer guide):
78
79 {{code}}
80 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
81 nvm install 10
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
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.
103
104 Use that to install windows-build-tools by executing the command in an administrative powershell.
105
106 {{code}}
107 npm install -g windows-build-tools
108 {{/code}}
109
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.
111
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
114 Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable||shape="rect"]].
115
116 === Known Problems in this step ===
117
118 If python3 was already installed this may cause some problems.
119
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
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).
133
134 = Stuff that may help =
135
136 == How to run KEITH in developer setup (socket) ==
137
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}}
171 {{/layout-cell}}
172 {{/layout-section}}
173
174 {{layout-section ac:type="single"}}
175 {{layout-cell}}
176 == (% style="letter-spacing: -0.008em;" %)Running the already build LS(%%) ==
177
178 \\
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}}
183
184 \\
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.
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}}
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
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:
201
202 [[image:attach:image2019-2-7_17-58-22.png]]
203
204 Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
205
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}}
216
217 \\
218
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
223 {{layout-section ac:type="single"}}
224 {{layout-cell}}
225 = Known Issues =
226
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
233 //(this might already be resolved, has not been tested yet though)//
234
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
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}}
241
242 * run
243
244 {{code language="none"}}
245 yarn run rebuild:electron/browser
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).
255 )))
256 {{/layout-cell}}
257 {{/layout-section}}
258 {{/layout}}

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage