Wiki source code of Running KEITH

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

Navigation

Quick Links

KIELER on GitHub
RTSYS Homepage