Wiki source code of Running KEITH

Version 35.1 by Soeren Domroes on 2020/04/06 14:42
Show last authors
1 = Running KEITH =
2
3
4
5 {{toc maxLevel="2"/}}
6
7 == Setting up your Eclipse ==
8
9 For everything not mentioned here refer to [[Getting Eclipse>>doc:KIELER.Getting Eclipse||shape="rect"]] guide.
10
11 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.
12
13 If you plan to develop in elk at the same time first select the Eclispe Layout Kernel setup and after that the semantics or pragmatics setup.
14
15 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.
16
17 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)
18
19 == [[image:attach:Screenshot from 2019-02-15 14-10-50.png]] ==
20
21 \\
22
23 You have to edit the arguments too. The Vm arguments host and port are added to connect the LS via socket:
24
25 {{code}}
26 -os ${target.os} -ws ${target.ws} -arch ${target.arch} -nl ${target.nl} -consoleLog
27 {{/code}}
28
29 {{code}}
30 -Dhost=localhost -Dport=5007
31 {{/code}}
32
33 \\
34
35 [[image:attach:Screenshot from 2019-02-15 14-13-34.png]]
36
37 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.
38
39 == Setting up a KEITH developer setup... ==
40
41 General requirements:
42
43 * node (and additional dependencies see [[Theia developer guide>>url:https://github.com/theia-ide/theia/blob/master/doc/Developing.md||shape="rect"]])
44 * npm (whatever node installs)
45 * yarn (latest version)
46 * Python (2.7.X)
47 * gcc, g++, and make (for native dependencies of some npm packages)
48 * [[Visual Studio Code>>url:https://code.visualstudio.com/||shape="rect"]] (latest version)
49 * a cloned [[keith >>url:https://git.rtsys.informatik.uni-kiel.de/projects/KIELER/repos/keith/browse||shape="rect"]]repository
50
51 == ... on linux: ==
52
53 (Theia has a [[guide >>url:https://www.theia-ide.org/doc/authoring_extensions||shape="rect"]]for extension development that might be helpful)
54
55 install node 8:
56
57 {{code}}
58 curl -o- https://raw.githubusercontent.com/creationix/nvm/v0.33.5/install.sh | bash
59 nvm install 8
60 {{/code}}
61
62 Install python if you haven't (remember: Python 2: , Python 3: ).
63
64 {{code language="none"}}
65 Install yarn (a package manager build on the package manager npm):
66 {{/code}}
67
68 {{{}}}
69
70 \\
71
72 {{code}}
73 npm install -g yarn
74 {{/code}}
75
76 \\
77
78 == ... on windows: ==
79
80 Install [[node 8>>url:https://nodejs.org/download/release/v8.15.0/||shape="rect"]] for windows. I personally used the {{code language="none"}}.msi{{/code}}.
81
82 Use that to install windows-build-tools by executing the command in an administrative powershell.
83
84 {{code}}
85 npm install -g windows-build-tools
86 {{/code}}
87
88 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.
89
90 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.
91
92 Yarn can be downloaded and installed from [[here>>url:https://yarnpkg.com/lang/en/docs/install/#windows-stable||shape="rect"]].
93
94 === Known Problems in this step ===
95
96 If python3 was already installed this may cause some problems.
97
98 == ... on mac: ==
99
100 Get a package manager, something like [[brew>>url:https://brew.sh/index_de||shape="rect"]].
101
102 Use brew to install all necessary stuff.
103
104 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:
105
106 {{code}}
107 xcode-select --install
108 {{/code}}
109
110 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).
111
112 = Stuff that may help =
113
114 == How to run KEITH in developer setup (socket) ==
115
116 Run the following to build and run KEITH in its developer setup (in socket mode, so the LS has to be started separately)
117
118 === Running KEITH in the browser ===
119
120 \\
121
122 {{code language="bash"}}
123 yarn && cd keith-app && yarn run socket
124 {{/code}}
125
126 //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.
127
128 Per default the KEITH opens on localhost:3000.
129
130 {{info}}
131 If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:browser{{/code}}
132 {{/info}}
133
134 Run Launch in Chrome via VSCode to open a chrome browser on localhost:3000
135
136 This is necessary to be able to debug in VSCode.
137
138 === Running KEITH as (unbundled) electron app ===
139
140 {{code language="bash"}}
141 yarn && yarn run rebuild:electron && cd keith-app-electron && yarn run socket
142 {{/code}}
143
144 //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.
145
146 {{info}}
147 If you previously build keith electron, you have to execute {{code language="none"}}yarn run rebuild:electron{{/code}}
148 {{/info}}
149
150 == Running the already build LS (you normally do not want to do this) ==
151
152 Go to the latest [[Bamboo build>>url:https://rtsys.informatik.uni-kiel.de/bamboo/browse/KISEMA-NSI||shape="rect"]] and go to Artifacts.
153
154 [[image:attach:image2019-2-7_17-46-58.png]]
155
156 Select Language Server Zip and download the LS and unpack it somewhere.
157
158 Locate the kieler.ini file. Depending on the OS it has a different location (linux; toplevel, windows, toplevel, mac: Content/Eclipse/kieler.ini)
159
160 Paste the following at the beginning of the ini-file:
161
162 {{code language="bash"}}
163 -application
164 de.cau.cs.kieler.language.server.LanguageServer
165 -noSplash
166 {{/code}}
167
168 Since an Eclipse application is built, this is needed to start the LS without a splashscreen.
169
170 If you want to connect that LS via socket to your Theia application (KEITH) add the following to the vmargs:
171
172 {{code}}
173 -Dport=5007
174 {{/code}}
175
176 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:
177
178 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:
179
180 [[image:attach:image2019-2-7_17-58-22.png]]
181
182 Open the {{code language="none"}}package.json{{/code}}. In the{{code language="none"}} package.json{{/code}} are several scripts defined.
183
184 {{code language="js"}}
185 "scripts": {
186 "prepare": "yarn run clean && yarn build",
187 "clean": "theia clean",
188 "build": "theia build --mode development",
189 "start": "theia start --root-dir=../workspace",
190 "socket": "node ./src-gen/backend/main.js --root-dir=../workspace --LSP_PORT=5007 --port=3000 --loglevel=debug",
191 "watch": "theia build --watch --mode development"
192 },
193 {{/code}}
194
195 \\
196
197 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}}.
198
199 = Known Issues =
200
201 === Known issues for windows: ===
202
203 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.
204
205 === Known issues on mac: ===
206
207 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.
208
209 === Known issues: ===
210
211 * KEITH works in the browser/electron app, but not in the electron app/browser with the following error message:(((
212 {{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}}
213
214 * run
215
216 {{code language="none"}}
217 yarn run rebuild:electron/browser
218 {{/code}} after yarn to fix this. If it does not work, delete the
219
220 {{code language="none"}}
221 node_modules
222 {{/code}} folder and try again (for browser version rebuild browser is not needed, since
223
224 {{code language="none"}}
225 yarn
226 {{/code}} already builds the correct sources).
227 )))
228
229 \\

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage