/
NFClass.mo
566 lines (510 loc) · 15.5 KB
/
NFClass.mo
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
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
/*
* This file is part of OpenModelica.
*
* Copyright (c) 1998-2014, Open Source Modelica Consortium (OSMC),
* c/o Linköpings universitet, Department of Computer and Information Science,
* SE-58183 Linköping, Sweden.
*
* All rights reserved.
*
* THIS PROGRAM IS PROVIDED UNDER THE TERMS OF GPL VERSION 3 LICENSE OR
* THIS OSMC PUBLIC LICENSE (OSMC-PL) VERSION 1.2.
* ANY USE, REPRODUCTION OR DISTRIBUTION OF THIS PROGRAM CONSTITUTES
* RECIPIENT'S ACCEPTANCE OF THE OSMC PUBLIC LICENSE OR THE GPL VERSION 3,
* ACCORDING TO RECIPIENTS CHOICE.
*
* The OpenModelica software and the Open Source Modelica
* Consortium (OSMC) Public License (OSMC-PL) are obtained
* from OSMC, either from the above address,
* from the URLs: http://www.ida.liu.se/projects/OpenModelica or
* http://www.openmodelica.org, and in the OpenModelica distribution.
* GNU version 3 is obtained from: http://www.gnu.org/copyleft/gpl.html.
*
* This program is distributed WITHOUT ANY WARRANTY; without
* even the implied warranty of MERCHANTABILITY or FITNESS
* FOR A PARTICULAR PURPOSE, EXCEPT AS EXPRESSLY SET FORTH
* IN THE BY RECIPIENT SELECTED SUBSIDIARY LICENSE CONDITIONS OF OSMC-PL.
*
* See the full OSMC Public License conditions for more details.
*
*/
encapsulated package NFClass
import NFInstNode.InstNode;
import NFModifier.Modifier;
import NFStatement.Statement;
import SCode.Element;
import Type = NFType;
import NFComponent.Component;
import Dimension = NFDimension;
import NFClassTree.ClassTree;
import NFSections.Sections;
import Restriction = NFRestriction;
import Expression = NFExpression;
protected
import NFBinding.Binding;
import ComplexType = NFComplexType;
public
constant Class.Prefixes DEFAULT_PREFIXES = Class.Prefixes.PREFIXES(
SCode.Encapsulated.NOT_ENCAPSULATED(),
SCode.Partial.NOT_PARTIAL(),
SCode.Final.NOT_FINAL(),
Absyn.InnerOuter.NOT_INNER_OUTER(),
SCode.Replaceable.NOT_REPLACEABLE()
);
uniontype Class
uniontype Prefixes
record PREFIXES
SCode.Encapsulated encapsulatedPrefix;
SCode.Partial partialPrefix;
SCode.Final finalPrefix;
Absyn.InnerOuter innerOuter;
SCode.Replaceable replaceablePrefix;
end PREFIXES;
function isEqual
input Prefixes prefs1;
input Prefixes prefs2;
output Boolean isEqual = valueEq(prefs1, prefs2);
end isEqual;
end Prefixes;
record NOT_INSTANTIATED end NOT_INSTANTIATED;
record PARTIAL_CLASS
ClassTree elements;
Modifier modifier;
Class.Prefixes prefixes;
end PARTIAL_CLASS;
record PARTIAL_BUILTIN
Type ty;
ClassTree elements;
Modifier modifier;
Restriction restriction;
end PARTIAL_BUILTIN;
record EXPANDED_CLASS
ClassTree elements;
Modifier modifier;
Class.Prefixes prefixes;
Restriction restriction;
end EXPANDED_CLASS;
record EXPANDED_DERIVED
InstNode baseClass;
Modifier modifier;
array<Dimension> dims;
Class.Prefixes prefixes;
Component.Attributes attributes;
Restriction restriction;
end EXPANDED_DERIVED;
record INSTANCED_CLASS
Type ty;
ClassTree elements;
Sections sections;
Restriction restriction;
end INSTANCED_CLASS;
record INSTANCED_BUILTIN
Type ty;
ClassTree elements;
Restriction restriction;
end INSTANCED_BUILTIN;
record TYPED_DERIVED
Type ty;
InstNode baseClass;
Restriction restriction;
end TYPED_DERIVED;
record DAE_TYPE
DAE.Type ty;
end DAE_TYPE;
function fromSCode
input list<SCode.Element> elements;
input Boolean isClassExtends;
input InstNode scope;
input Prefixes prefixes;
output Class cls;
protected
ClassTree tree;
algorithm
tree := ClassTree.fromSCode(elements, isClassExtends, scope);
cls := PARTIAL_CLASS(tree, Modifier.NOMOD(), prefixes);
end fromSCode;
function fromEnumeration
input list<SCode.Enum> literals;
input Type enumType;
input InstNode enumClass;
output Class cls;
protected
ClassTree tree;
algorithm
tree := ClassTree.fromEnumeration(literals, enumType, enumClass);
cls := PARTIAL_BUILTIN(enumType, tree, Modifier.NOMOD(),
Restriction.ENUMERATION());
end fromEnumeration;
function makeRecordConstructor
input list<InstNode> inputs;
input list<InstNode> locals;
input InstNode out;
output Class cls;
protected
ClassTree tree;
algorithm
tree := ClassTree.fromRecordConstructor(inputs, locals, out);
cls := INSTANCED_CLASS(Type.UNKNOWN(), tree, Sections.EMPTY(), Restriction.RECORD_CONSTRUCTOR());
end makeRecordConstructor;
function initExpandedClass
input output Class cls;
algorithm
cls := match cls
case PARTIAL_CLASS()
then EXPANDED_CLASS(cls.elements, cls.modifier, cls.prefixes, Restriction.UNKNOWN());
end match;
end initExpandedClass;
function getSections
input Class cls;
output Sections sections;
algorithm
sections := match cls
case INSTANCED_CLASS() then cls.sections;
case TYPED_DERIVED() then getSections(InstNode.getClass(cls.baseClass));
else Sections.EMPTY();
end match;
end getSections;
function setSections
input Sections sections;
input output Class cls;
algorithm
cls := match cls
case INSTANCED_CLASS()
then INSTANCED_CLASS(cls.ty, cls.elements, sections, cls.restriction);
end match;
end setSections;
function lookupElement
input String name;
input Class cls;
output InstNode node;
output Boolean isImport;
algorithm
(node, isImport) := ClassTree.lookupElement(name, classTree(cls));
end lookupElement;
function lookupAttributeBinding
input String name;
input Class cls;
output Binding binding;
protected
InstNode attr_node;
algorithm
try
attr_node := ClassTree.lookupElement(name, classTree(cls));
binding := Modifier.binding(Component.getModifier(InstNode.component(attr_node)));
else
binding := NFBinding.EMPTY_BINDING;
end try;
end lookupAttributeBinding;
function lookupAttributeValue
input String name;
input Class cls;
output Option<Expression> value = Binding.typedExp(lookupAttributeBinding(name, cls));
end lookupAttributeValue;
function isBuiltin
input Class cls;
output Boolean isBuiltin;
algorithm
isBuiltin := match cls
case PARTIAL_BUILTIN() then true;
case INSTANCED_BUILTIN() then true;
case EXPANDED_DERIVED() then isBuiltin(InstNode.getClass(cls.baseClass));
case TYPED_DERIVED() then isBuiltin(InstNode.getClass(cls.baseClass));
else false;
end match;
end isBuiltin;
function classTree
input Class cls;
output ClassTree tree;
algorithm
tree := match cls
case Class.PARTIAL_CLASS() then cls.elements;
case Class.PARTIAL_BUILTIN() then cls.elements;
case Class.EXPANDED_CLASS() then cls.elements;
case Class.EXPANDED_DERIVED() then classTree(InstNode.getClass(cls.baseClass));
case Class.INSTANCED_CLASS() then cls.elements;
case Class.INSTANCED_BUILTIN() then cls.elements;
case Class.TYPED_DERIVED() then classTree(InstNode.getClass(cls.baseClass));
end match;
end classTree;
function setClassTree
input ClassTree tree;
input output Class cls;
algorithm
() := match cls
case Class.PARTIAL_CLASS() algorithm cls.elements := tree; then ();
case Class.EXPANDED_CLASS() algorithm cls.elements := tree; then ();
case Class.PARTIAL_BUILTIN() algorithm cls.elements := tree; then ();
case Class.INSTANCED_CLASS() algorithm cls.elements := tree; then ();
case Class.INSTANCED_BUILTIN() algorithm cls.elements := tree; then ();
end match;
end setClassTree;
function getModifier
input Class cls;
output Modifier modifier;
algorithm
modifier := match cls
case PARTIAL_CLASS() then cls.modifier;
case EXPANDED_CLASS() then cls.modifier;
case EXPANDED_DERIVED() then cls.modifier;
case PARTIAL_BUILTIN() then cls.modifier;
else Modifier.NOMOD();
end match;
end getModifier;
function setModifier
input Modifier modifier;
input output Class cls;
algorithm
() := match cls
case PARTIAL_CLASS()
algorithm
cls.modifier := modifier;
then
();
case EXPANDED_CLASS()
algorithm
cls.modifier := modifier;
then
();
case EXPANDED_DERIVED()
algorithm
cls.modifier := modifier;
then
();
case PARTIAL_BUILTIN()
algorithm
cls.modifier := modifier;
then
();
else
algorithm
Error.assertion(false, getInstanceName() + " got non-modifiable class", sourceInfo());
then
fail();
end match;
end setModifier;
function mergeModifier
input Modifier modifier;
input output Class cls;
algorithm
() := match cls
case PARTIAL_CLASS()
algorithm
cls.modifier := Modifier.merge(modifier, cls.modifier);
then
();
case EXPANDED_CLASS()
algorithm
cls.modifier := Modifier.merge(modifier, cls.modifier);
then
();
case EXPANDED_DERIVED()
algorithm
cls.modifier := Modifier.merge(modifier, cls.modifier);
then
();
case PARTIAL_BUILTIN()
algorithm
cls.modifier := Modifier.merge(modifier, cls.modifier);
then
();
else
algorithm
Error.assertion(false, getInstanceName() + " got non-modifiable class", sourceInfo());
then
fail();
end match;
end mergeModifier;
function isIdentical
input Class cls1;
input Class cls2;
output Boolean identical = false;
algorithm
if referenceEq(cls1, cls2) then
identical := true;
else
identical := match (cls1, cls2)
case (EXPANDED_CLASS(), EXPANDED_CLASS())
then Prefixes.isEqual(cls1.prefixes, cls2.prefixes) and
ClassTree.isIdentical(cls1.elements, cls2.elements);
case (INSTANCED_BUILTIN(), INSTANCED_BUILTIN())
algorithm
if not Type.isEqual(cls1.ty, cls2.ty) then
return;
end if;
then
true;
else true;
end match;
end if;
end isIdentical;
function getDimensions
input Class cls;
output list<Dimension> dims;
algorithm
dims := match cls
case INSTANCED_CLASS() then Type.arrayDims(cls.ty);
case INSTANCED_BUILTIN() then Type.arrayDims(cls.ty);
case TYPED_DERIVED() then Type.arrayDims(cls.ty);
else {};
end match;
end getDimensions;
function getAttributes
input Class cls;
output Component.Attributes attr;
algorithm
attr := match cls
case EXPANDED_DERIVED() then cls.attributes;
else NFComponent.DEFAULT_ATTR;
end match;
end getAttributes;
function getTypeAttributes
input Class cls;
output list<Modifier> attributes = {};
protected
array<InstNode> comps;
Modifier mod;
algorithm
try
comps := ClassTree.getComponents(classTree(cls));
for c in comps loop
mod := Component.getModifier(InstNode.component(c));
if not Modifier.isEmpty(mod) then
attributes := mod :: attributes;
end if;
end for;
else
end try;
end getTypeAttributes;
function getType
input Class cls;
input InstNode clsNode;
output Type ty;
algorithm
ty := match cls
case PARTIAL_BUILTIN() then cls.ty;
case EXPANDED_DERIVED() then getType(InstNode.getClass(cls.baseClass), cls.baseClass);
case INSTANCED_CLASS() then cls.ty;
case INSTANCED_BUILTIN()
then match cls.ty
case Type.POLYMORPHIC("") then Type.POLYMORPHIC(InstNode.name(clsNode));
else cls.ty;
end match;
case TYPED_DERIVED() then cls.ty;
else Type.UNKNOWN();
end match;
end getType;
function restriction
input Class cls;
output Restriction res;
algorithm
res := match cls
case PARTIAL_BUILTIN() then cls.restriction;
case EXPANDED_CLASS() then cls.restriction;
case EXPANDED_DERIVED() then cls.restriction;
case INSTANCED_CLASS() then cls.restriction;
case INSTANCED_BUILTIN() then cls.restriction;
case TYPED_DERIVED() then cls.restriction;
else Restriction.UNKNOWN();
end match;
end restriction;
function setRestriction
input Restriction res;
input output Class cls;
algorithm
() := match cls
// PARTIAL_BUILTIN is only used for predefined builtin types and not needed here.
case EXPANDED_CLASS() algorithm cls.restriction := res; then ();
case EXPANDED_DERIVED() algorithm cls.restriction := res; then ();
case INSTANCED_CLASS() algorithm cls.restriction := res; then ();
case INSTANCED_BUILTIN() algorithm cls.restriction := res; then ();
case TYPED_DERIVED() algorithm cls.restriction := res; then ();
end match;
end setRestriction;
function isConnectorClass
input Class cls;
output Boolean isConnector = Restriction.isConnector(restriction(cls));
end isConnectorClass;
function isExternalObject
input Class cls;
output Boolean isExternalObject = Restriction.isExternalObject(restriction(cls));
end isExternalObject;
function isFunction
input Class cls;
output Boolean isFunction = Restriction.isFunction(restriction(cls));
end isFunction;
function isExternalFunction
input Class cls;
output Boolean isExtFunc;
algorithm
isExtFunc := match cls
local
String lang;
case EXPANDED_DERIVED() then isExternalFunction(InstNode.getClass(cls.baseClass));
case INSTANCED_CLASS(sections = Sections.EXTERNAL(language = lang)) then lang <> "builtin";
case TYPED_DERIVED() then isExternalFunction(InstNode.getClass(cls.baseClass));
else false;
end match;
end isExternalFunction;
function isOverdetermined
input Class cls;
output Boolean isOverdetermined;
algorithm
try
lookupElement("equalityConstraint", cls);
isOverdetermined := true;
else
isOverdetermined := false;
end try;
end isOverdetermined;
function getPrefixes
input Class cls;
output Prefixes prefs;
algorithm
prefs := match cls
case PARTIAL_CLASS() then cls.prefixes;
case EXPANDED_CLASS() then cls.prefixes;
case EXPANDED_DERIVED() then cls.prefixes;
end match;
end getPrefixes;
function setPrefixes
input Prefixes prefs;
input output Class cls;
algorithm
() := match cls
case EXPANDED_CLASS()
algorithm
cls.prefixes := prefs;
then
();
case EXPANDED_DERIVED()
algorithm
cls.prefixes := prefs;
then
();
end match;
end setPrefixes;
function isEncapsulated
input Class cls;
output Boolean isEncapsulated;
algorithm
isEncapsulated := match cls
case PARTIAL_CLASS() then SCode.encapsulatedBool(cls.prefixes.encapsulatedPrefix);
case EXPANDED_CLASS() then SCode.encapsulatedBool(cls.prefixes.encapsulatedPrefix);
case EXPANDED_DERIVED() then SCode.encapsulatedBool(cls.prefixes.encapsulatedPrefix);
else false;
end match;
end isEncapsulated;
function lastBaseClass
input output InstNode node;
protected
Class cls = InstNode.getClass(node);
algorithm
node := match cls
case EXPANDED_DERIVED() then lastBaseClass(cls.baseClass);
case TYPED_DERIVED() then lastBaseClass(cls.baseClass);
else node;
end match;
end lastBaseClass;
end Class;
annotation(__OpenModelica_Interface="frontend");
end NFClass;