-
Notifications
You must be signed in to change notification settings - Fork 297
/
NFRecord.mo
348 lines (307 loc) · 10.5 KB
/
NFRecord.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
/*
* 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 NFRecord
" file: NFRecord.mo
package: NFRecord
description: package for handling records.
Functions used by NFInst for handling records.
"
import Binding = NFBinding;
import Class = NFClass;
import Component = NFComponent;
import Dimension = NFDimension;
import Expression = NFExpression;
import NFInstNode.InstNode;
import NFInstNode.InstNodeType;
import Type = NFType;
import Subscript = NFSubscript;
import InstContext = NFInstContext;
protected
import Inst = NFInst;
import Lookup = NFLookup;
import TypeCheck = NFTypeCheck;
import Typing = NFTyping;
import NFPrefixes.Direction;
import NFPrefixes.Variability;
import NFPrefixes.Visibility;
import NFFunction.Function;
import NFClassTree.ClassTree;
import ComplexType = NFComplexType;
import ComponentRef = NFComponentRef;
import NFFunction.FunctionStatus;
import MetaModelica.Dangerous.listReverseInPlace;
import UnorderedSet;
public
encapsulated uniontype Field
record INPUT
String name;
end INPUT;
record LOCAL
String name;
end LOCAL;
function isInput
input Field field;
output Boolean isInput;
algorithm
isInput := match field
case INPUT() then true;
else false;
end match;
end isInput;
function name
input Field field;
output String name;
algorithm
name := match field
case INPUT() then field.name;
case LOCAL() then field.name;
end match;
end name;
end Field;
function instDefaultConstructor
input Absyn.Path path;
input output InstNode node;
input InstContext.Type context;
input SourceInfo info;
protected
list<InstNode> inputs, locals, all_params, sorted_locals;
DAE.FunctionAttributes attr;
Pointer<FunctionStatus> status;
InstNode ctor_node, out_rec;
Component out_comp;
Class ctor_cls;
InstContext.Type ctor_context;
algorithm
// The node we get is usually a record instance, with applied modifiers and so on.
// So the first thing we do is to create a "pure" instance of the record.
// TODO: The lookup will fail for records declared in redeclare modifiers,
// since the parent will be the class scope of the modifier instead of
// the element being modified. In that case we just reinstantiate the
// record completely, but this probably isn't entirely correct. We
// should make the expanded but not fully instantiated class available
// here somehow.
try
ctor_node := Lookup.lookupLocalSimpleName(InstNode.name(node), InstNode.classScope(InstNode.parent(node)));
true := referenceEq(InstNode.definition(node), InstNode.definition(ctor_node));
else
ctor_node := InstNode.replaceClass(Class.NOT_INSTANTIATED(), node);
end try;
ctor_context := InstContext.set(context, NFInstContext.RELAXED);
ctor_node := InstNode.setNodeType(NFInstNode.InstNodeType.ROOT_CLASS(InstNode.parent(node)), ctor_node);
ctor_node := Inst.instantiate(ctor_node, context = ctor_context);
Inst.instExpressions(ctor_node, context = ctor_context);
// Collect the record fields.
(inputs, locals, all_params) := collectRecordParams(ctor_node);
// TODO: The local fields can contain depenencies on each other which requires
// reordering them such that they can be initialized before they're used.
// But the code generation uses the type of the record constructor both
// for generating the record struct and the record constructor, so we
// can't currently reorder variables here without also messing up the
// order of the record itself.
//sorted_locals := Function.sortLocals(locals, info);
//all_params := listAppend(inputs, sorted_locals);
// Create the output record element, using the instance created above as both parent and type.
out_comp := Component.UNTYPED_COMPONENT(ctor_node, listArray({}),
NFBinding.EMPTY_BINDING, NFBinding.EMPTY_BINDING,
NFComponent.OUTPUT_ATTR, NONE(), false, AbsynUtil.dummyInfo);
out_rec := InstNode.fromComponent("$out" + InstNode.name(ctor_node), out_comp, ctor_node);
// Make a record constructor class and create a node for the constructor.
ctor_cls := Class.makeRecordConstructor(all_params, out_rec);
ctor_node := InstNode.replaceClass(ctor_cls, ctor_node);
InstNode.classApply(ctor_node, Class.setType, Type.COMPLEX(ctor_node, ComplexType.CLASS()));
// Create the constructor function and add it to the function cache.
attr := DAE.FUNCTION_ATTRIBUTES_DEFAULT;
status := Pointer.create(FunctionStatus.INITIAL);
InstNode.cacheAddFunc(node, Function.FUNCTION(path, ctor_node, inputs,
{out_rec}, locals, {}, Type.UNKNOWN(), attr, {}, status, Pointer.create(0)), false);
end instDefaultConstructor;
function checkLocalFieldOrder
"Checks if the local variables in a record constructor requires reordering,
and issues an error in that case since we can't handle it yet."
input list<InstNode> locals;
input InstNode recNode;
input SourceInfo info;
protected
UnorderedSet<InstNode> locals_set;
list<InstNode> locs, deps;
InstNode loc;
algorithm
if listLength(locals) <= 1 then
return;
end if;
loc :: locs := listReverse(locals);
locals_set := UnorderedSet.fromList({loc}, InstNode.hash, InstNode.refEqual);
for l in locs loop
deps := Function.getLocalDependencies(l, locals_set);
if not listEmpty(deps) then
Error.addSourceMessage(Error.UNSUPPORTED_RECORD_REORDERING,
{InstNode.name(recNode)}, info);
fail();
end if;
UnorderedSet.add(l, locals_set);
end for;
end checkLocalFieldOrder;
function collectRecordParams
input InstNode recNode;
output list<InstNode> inputs = {};
output list<InstNode> locals = {};
output list<InstNode> allParams = {};
protected
InstNode comp;
array<InstNode> comps;
array<Mutable<InstNode>> pcomps;
ClassTree tree;
algorithm
tree := Class.classTree(InstNode.getClass(recNode));
() := match tree
case ClassTree.FLAT_TREE(components = comps)
algorithm
for i in arrayLength(comps):-1:1 loop
comp := comps[i];
(inputs, locals) := collectRecordParam(comp, inputs, locals);
allParams := comp :: allParams;
end for;
then
();
case ClassTree.INSTANTIATED_TREE(components = pcomps)
algorithm
for i in arrayLength(pcomps):-1:1 loop
comp := Mutable.access(pcomps[i]);
(inputs, locals) := collectRecordParam(comp, inputs, locals);
allParams := comp :: allParams;
end for;
then
();
else
algorithm
Error.assertion(false, getInstanceName() + " got non-instantiated function", sourceInfo());
then
fail();
end match;
end collectRecordParams;
function collectRecordParam
input InstNode component;
input output list<InstNode> inputs;
input output list<InstNode> locals;
protected
Component comp;
InstNode comp_node = InstNode.resolveInner(component);
algorithm
if InstNode.isProtected(comp_node) then
locals := comp_node :: locals;
return;
end if;
comp := InstNode.component(comp_node);
if Component.isModifiable(comp) then
setFieldDirection(comp_node, Direction.INPUT);
inputs := comp_node :: inputs;
else
setFieldDirection(comp_node, Direction.NONE);
locals := comp_node :: locals;
end if;
end collectRecordParam;
function setFieldDirection
input InstNode field;
input Direction direction;
protected
Component comp = InstNode.component(field);
Component.Attributes attr;
algorithm
attr := Component.getAttributes(comp);
attr.direction := direction;
comp := Component.setAttributes(attr, comp);
InstNode.updateComponent(comp, field);
end setFieldDirection;
function collectRecordFields
input InstNode recNode;
output list<Field> fields;
protected
ClassTree tree;
algorithm
tree := Class.classTree(InstNode.getClass(recNode));
fields := ClassTree.foldComponents(tree, collectRecordField, {});
fields := listReverseInPlace(fields);
end collectRecordFields;
function collectRecordField
input InstNode component;
input output list<Field> fields;
protected
InstNode comp_node = InstNode.resolveInner(component);
Component comp;
algorithm
if InstNode.isProtected(comp_node) then
fields := Field.LOCAL(InstNode.name(comp_node)) :: fields;
else
comp := InstNode.component(comp_node);
if not Component.isModifiable(comp) then
fields := Field.LOCAL(InstNode.name(comp_node)) :: fields;
elseif not Component.isOutput(comp) then
fields := Field.INPUT(InstNode.name(comp_node)) :: fields;
end if;
end if;
end collectRecordField;
function fieldsToDAE
input list<Field> fields;
output list<String> fieldNames = {};
algorithm
for field in fields loop
() := match field
case Field.INPUT()
algorithm
fieldNames := field.name :: fieldNames;
then
();
else ();
end match;
end for;
end fieldsToDAE;
function foldInputFields<T, ArgT>
input list<Field> fields;
input list<T> args;
input FuncT func;
input output ArgT foldArg;
partial function FuncT
input T arg;
input output ArgT foldArg;
end FuncT;
protected
T arg;
list<T> rest_args = args;
algorithm
for field in fields loop
arg :: rest_args := rest_args;
if Field.isInput(field) then
foldArg := func(arg, foldArg);
end if;
end for;
end foldInputFields;
annotation(__OpenModelica_Interface="frontend");
end NFRecord;