-
Notifications
You must be signed in to change notification settings - Fork 17
/
Copy pathdeveloper_page.htm
402 lines (102 loc) · 8.03 KB
/
developer_page.htm
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
<!DOCTYPE HTML PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html lang="en">
<head>
<meta content="text/html;charset=ISO-8859-1" http-equiv="Content-Type" />
<title>openEHR Eiffel Implementation Project</title>
<link rel="stylesheet" href="http://www.openehr.org/styles/oe.css" type="text/css" />
</head>
<body>
<h1>The <span style="font-style: italic;">open</span>EHR ref_impl_eiffel Project Developer's page
</h1>
<hr style="width: 100%; height: 2px;" />
<h2>What is in this project?</h2>
<p>There are 3 sections to this repository, as follows:</p>
<ul>
<li><span style="font-weight: bold;">libraries</span>: this is where the <span style="font-style: italic;">open</span>EHR reference model archetype models and supporting generic libraries are. Executables in this area are all test applications.</li>
<li><span style="font-weight: bold;">components</span>: re-usable
components based on the libraries are here. Includes .Net and
Java-wrapped DLLs (future: Linux .so libs) for ADL, and any other
deployable component form of the <span style="font-style: italic;">open</span>EHR models. Will eventually include an <span style="font-style: italic;">open</span>EHR archetype- and template-processing kernel</li>
<li><span style="font-weight: bold;">apps</span>: standalone
executable applications based on the libraries and/or components.
Includes the ADL workbench, and will eventually include EHR,
demographic and archetype servers.</li>
</ul>
<h2>Setting up for building</h2>
<p>There are a number of steps to do to ensure you are ready to build anything, as follows:</p>
<ul>
<li>Download and install <a href="http://dev.eiffel.com/Downloads">EiffelStudio 7.1</a> (free use license).</li>
<ul>
<li>During installation, when it asks whether to precompile the libraries, you can choose No.</li>
</ul>
<li>You can, if you wish, build individual projects within the EiffelStudio IDE; but if you wish to do batch command-line builds, you need SCons. SCons is a software build utility, based on Python, and it only takes a few minutes to install.</li>
<ul>
<li>Download and install <a href="http://www.python.org">Python 2.5</a> or higher. (Do not install Python 3.0 or higher!)</li>
<li>Download and install <a href="http://www.scons.org">SCons 2.0</a> or higher.</li>
</ul>
<li>On <span style="font-weight: bold;">Windows</span>, if you wish to build an installer for ADL Workbench, download and install <a href="http://nsis.sourceforge.net">NSIS</a>.</li>
</ul>
<h2>Building</h2>
<p>The SCons-based facility for building the entire project works on Windows, Linux and Mac.</p>
<p>The approach is:</p>
<ul>
<li>Make sure that SCons, Python and the Eiffel compiler are in your PATH.</li>
<li>On <span style="font-weight: bold;">Windows</span>:
<ul>
<li>Make sure NSIS is in your path too if you installed it.</li>
</ul>
</li>
<li>On <span style="font-weight: bold;">Linux</span> or <span style="font-weight: bold;">Mac</span>, make sure that you have also set the EiffelStudio environment variables. For example, on a Mac, your <span style="font-weight: bold;">.profile</span> might contain this:
<ul>
<li>export <span style="font-weight: bold;">ISE_PLATFORM</span>=macosx-x86</li>
<li>export <span style="font-weight: bold;">ISE_EIFFEL</span>=/Applications/MacPorts/Eiffel71</li>
<li>export <span style="font-weight: bold;">GOBO</span>=$ISE_EIFFEL/library/gobo</li>
<li>export <span style="font-weight: bold;">ES_PATH</span>=$ISE_EIFFEL/studio/spec/$ISE_PLATFORM/bin</li>
<li>export <span style="font-weight: bold;">PATH</span>=$ES_PATH:$GOBO/spec/$ISE_PLATFORM/bin:$PATH</li>
</ul>
</li>
<li>Open a Windows command window, or a Linux or Mac terminal window.</li>
<li>Change directory to the project root directory.</li>
<li>To build all of the binaries, simply type <span style="font-weight: bold;">scons</span>.</li>
</ul>
<p>SCons provides many other options, depending how and what you want to build. For example:</p>
<ul>
<li>To build just ADL Workbench, type <span style="font-weight: bold;">scons adl_workbench</span>.</li>
<li>To create installers for the current platform, specify a file or directory target that contains <span style="font-weight: bold;">oe_distrib</span> as a path component. For example, to build the installers below the current directory's parent, type <span style="font-weight: bold;">scons ../oe_distrib/</span>.</li>
<li>For a list of the SCons command-line options, type <span style="font-weight: bold;">scons -h</span>.</li>
</ul>
Building without SCons is not hard. Just start EiffelStudio by hand and then tell it to build from an existing ECF file.
Depending on what you want to build, you just select the ECF file in the appropriate directory.
<h2>Build Targets (what can I build?)</h2>
<p>The current build targets are as follows:</p>
<ul>
<li><span style="font-weight: bold;">libraries area</span>: </li>
<ul>
<li>common_libs\test\app - a tester for dADL, method dispatcher, units library and others; (currently not being maintained - out of date!)</li>
<li>openehr\test\app - a tester for the openEHR reference model classes (currently not being maintained - out of date!)</li>
</ul>
<li><span style="font-weight: bold;">component area</span>:</li>
<ul>
<li>components\adl_parser\test\app - a tester for the ADL parser (currently not being maintained - out of date!)</li>
<li>components\adl_parser\lib\dotnet_dll - the <span style="font-weight: bold;">.NET DLL</span> form of the ADL parser</li>
<li>components\adl_parser\lib\java_lib - the <span style="font-weight: bold;">JNI-wrapped DLL</span> form of the ADL parser (currently not being maintained - out of date!)</li>
</ul>
<li><span style="font-weight: bold;">apps area</span>:</li>
<ul>
<li>apps\adl_workbench\app - <span style="font-weight: bold;">adl_workbench</span>, an EiffelVision2-based GUI application for ADL parsing, viewing and saving.</li>
</ul>
</ul>
<h2>Parser Grammars</h2>
The following are links to the grammars of the various parsers:<br />
<ul>
<li>ADL (<a href="components/adl_parser/src/syntax/adl/parser/adl_validator.y">.y file</a>) (<a href="components/adl_parser/src/syntax/adl/parser/adl_validator.html">html documentation</a>)</li>
<li>cADL (<a href="components/adl_parser/src/syntax/cadl/parser/cadl_validator.y">.y file</a>) (<a href="components/adl_parser/src/syntax/cadl/parser/cadl_validator.html">html documentation</a>)</li>
<li>dADL (<a href="libraries/common_libs/src/structures/syntax/dadl/parser/dadl2_validator.y">.y file</a>) (<a href="libraries/common_libs/src/structures/syntax/dadl/parser/dadl2_validator.html">html documentation</a>)</li>
<li>ADL Path Syntax (<a href="libraries/common_libs/src/structures/object_graph/path/og_path_validator.y">.y file</a>) (<a href="libraries/common_libs/src/structures/object_graph/path/og_path_validator.html">html documentation</a>)</li>
<li>Units parser (<a href="libraries/common_libs/src/unit_parser/parser/units_parser.y">.y file</a>) (<a href="libraries/common_libs/src/unit_parser/parser/units_parser.html">html documentation</a>)</li>
</ul>
<hr style="width: 100%; height: 2px;" />
<p class="footer">$LastChangedDate$
$LastChangedRevision$</p>
</body>
</html>