-
Notifications
You must be signed in to change notification settings - Fork 115
/
resolveStatements.ts
1045 lines (966 loc) · 38.8 KB
/
resolveStatements.ts
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
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
import { CompilerContext } from "../context";
import {
AstCondition,
AstStatement,
tryExtractPath,
AstId,
idText,
isWildcard,
selfId,
isSelfId,
eqNames,
} from "../grammar/ast";
import { isAssignable } from "./subtyping";
import {
idTextErr,
throwCompilationError,
throwConstEvalError,
throwInternalCompilerError,
} from "../errors";
import {
getAllStaticFunctions,
getStaticConstant,
getType,
hasStaticConstant,
resolveTypeRef,
getAllTypes,
} from "./resolveDescriptors";
import { getExpType, resolveExpression } from "./resolveExpression";
import { FunctionDescription, printTypeRef, TypeRef } from "./types";
import { evalConstantExpression } from "../constEval";
import { ensureInt } from "../interpreter";
import { crc16 } from "../utils/crc16";
import { SrcInfo } from "../grammar";
export type StatementContext = {
root: SrcInfo;
funName: string | null;
returns: TypeRef;
vars: Map<string, TypeRef>;
requiredFields: string[];
};
export function emptyContext(
root: SrcInfo,
funName: string | null,
returns: TypeRef,
): StatementContext {
return {
root,
funName,
returns,
vars: new Map(),
requiredFields: [],
};
}
function checkVariableExists(
ctx: CompilerContext,
sctx: StatementContext,
name: AstId,
): void {
if (sctx.vars.has(idText(name))) {
throwCompilationError(
`Variable already exists: ${idTextErr(name)}`,
name.loc,
);
}
// Check if the user tries to shadow the current function name
if (sctx.funName === idText(name)) {
throwCompilationError(
`Variable cannot have the same name as its enclosing function: ${idTextErr(name)}`,
name.loc,
);
}
if (hasStaticConstant(ctx, idText(name))) {
if (name.loc.origin === "stdlib") {
const constLoc = getStaticConstant(ctx, idText(name)).loc;
throwCompilationError(
`Constant ${idTextErr(name)} is shadowing an identifier defined in the Tact standard library: pick a different constant name`,
constLoc,
);
} else {
throwCompilationError(
`Variable ${idTextErr(name)} is trying to shadow an existing constant with the same name`,
name.loc,
);
}
}
}
function addRequiredVariables(
name: string,
src: StatementContext,
): StatementContext {
if (src.requiredFields.find((v) => v === name)) {
throwInternalCompilerError(`Variable already exists: ${name}`); // Should happen earlier
}
return {
...src,
requiredFields: [...src.requiredFields, name],
};
}
function removeRequiredVariable(
name: string,
src: StatementContext,
): StatementContext {
if (!src.requiredFields.find((v) => v === name)) {
throwInternalCompilerError(`Variable is not required: ${name}`); // Should happen earlier
}
const filtered = src.requiredFields.filter((v) => v !== name);
return {
...src,
requiredFields: filtered,
};
}
function addVariable(
name: AstId,
ref: TypeRef,
ctx: CompilerContext,
sctx: StatementContext,
): StatementContext {
checkVariableExists(ctx, sctx, name); // Should happen earlier
if (isWildcard(name)) {
return sctx;
}
return {
...sctx,
vars: new Map(sctx.vars).set(idText(name), ref),
};
}
function processCondition(
condition: AstCondition,
sctx: StatementContext,
ctx: CompilerContext,
): {
ctx: CompilerContext;
sctx: StatementContext;
returnAlwaysReachable: boolean;
} {
// Process expression
ctx = resolveExpression(condition.condition, sctx, ctx);
let initialCtx = sctx;
// Simple if
if (condition.falseStatements === null && condition.elseif === null) {
const r = processStatements(condition.trueStatements, initialCtx, ctx);
ctx = r.ctx;
return { ctx, sctx: initialCtx, returnAlwaysReachable: false };
}
// Simple if-else
const processedCtx: StatementContext[] = [];
const returnAlwaysReachableInAllBranches: boolean[] = [];
// Process true branch
const r = processStatements(condition.trueStatements, initialCtx, ctx);
ctx = r.ctx;
processedCtx.push(r.sctx);
returnAlwaysReachableInAllBranches.push(r.returnAlwaysReachable);
// Process else/elseif branch
if (condition.falseStatements !== null && condition.elseif === null) {
// if-else
const r = processStatements(condition.falseStatements, initialCtx, ctx);
ctx = r.ctx;
processedCtx.push(r.sctx);
returnAlwaysReachableInAllBranches.push(r.returnAlwaysReachable);
} else if (
condition.falseStatements === null &&
condition.elseif !== null
) {
// if-else if
const r = processCondition(condition.elseif, initialCtx, ctx);
ctx = r.ctx;
processedCtx.push(r.sctx);
returnAlwaysReachableInAllBranches.push(r.returnAlwaysReachable);
} else {
throwInternalCompilerError("Impossible");
}
// Merge statement contexts
const removed: string[] = [];
for (const f of initialCtx.requiredFields) {
let found = false;
for (const c of processedCtx) {
if (c.requiredFields.find((v) => v === f)) {
found = true;
break;
}
}
if (!found) {
removed.push(f);
}
}
for (const r of removed) {
initialCtx = removeRequiredVariable(r, initialCtx);
}
return {
ctx,
sctx: initialCtx,
returnAlwaysReachable: returnAlwaysReachableInAllBranches.every(
(x) => x,
),
};
}
// Precondition: `self` here means a contract or a trait,
// and not a `self` parameter of a mutating method
export function isLvalue(path: AstId[], ctx: CompilerContext): boolean {
const headId = path[0]!;
if (isSelfId(headId) && path.length > 1) {
// we can be dealing with a contract/trait constant `self.constFoo`
const selfTypeRef = getExpType(ctx, headId);
if (selfTypeRef.kind == "ref") {
const contractTypeDescription = getType(ctx, selfTypeRef.name);
return (
contractTypeDescription.constants.findIndex((constDescr) =>
eqNames(path[1]!, constDescr.name),
) === -1
);
} else {
return true;
}
} else {
// if the head path symbol is a global constant, then the whole path expression is a constant
return !hasStaticConstant(ctx, idText(headId));
}
}
function processStatements(
statements: AstStatement[],
sctx: StatementContext,
ctx: CompilerContext,
): {
ctx: CompilerContext;
sctx: StatementContext;
returnAlwaysReachable: boolean;
} {
// Process statements
let returnAlwaysReachable = false;
for (const s of statements) {
// Check for unreachable
if (returnAlwaysReachable) {
throwCompilationError("Unreachable statement", s.loc);
}
// Process statement
switch (s.kind) {
case "statement_let":
{
// Process expression
ctx = resolveExpression(s.expression, sctx, ctx);
// Check variable name
checkVariableExists(ctx, sctx, s.name);
// Check type
const expressionType = getExpType(ctx, s.expression);
if (s.type !== null) {
const variableType = resolveTypeRef(ctx, s.type);
if (!isAssignable(expressionType, variableType)) {
throwCompilationError(
`Type mismatch: "${printTypeRef(expressionType)}" is not assignable to "${printTypeRef(variableType)}"`,
s.loc,
);
}
sctx = addVariable(s.name, variableType, ctx, sctx);
} else {
if (expressionType.kind === "null") {
throwCompilationError(
`Cannot infer type for ${idTextErr(s.name)}`,
s.loc,
);
}
if (expressionType.kind === "void") {
throwCompilationError(
`The inferred type of variable ${idTextErr(s.name)} is "void", which is not allowed`,
s.loc,
);
}
sctx = addVariable(s.name, expressionType, ctx, sctx);
}
}
break;
case "statement_assign":
{
const tempSctx = { ...sctx, requiredFields: [] };
// Process lvalue
ctx = resolveExpression(s.path, tempSctx, ctx);
const path = tryExtractPath(s.path);
if (path === null) {
throwCompilationError(
`Assignments are allowed only into path expressions, i.e. identifiers, or sequences of direct contract/struct/message accesses, like "self.foo" or "self.structure.field"`,
s.path.loc,
);
}
if (!isLvalue(path, ctx)) {
throwCompilationError(
"Modifications of constant expressions are not allowed",
s.path.loc,
);
}
// Process expression
ctx = resolveExpression(s.expression, sctx, ctx);
// Check type
const expressionType = getExpType(ctx, s.expression);
const tailType = getExpType(ctx, s.path);
if (!isAssignable(expressionType, tailType)) {
throwCompilationError(
`Type mismatch: "${printTypeRef(expressionType)}" is not assignable to "${printTypeRef(tailType)}"`,
s.loc,
);
}
// Mark as assigned
if (path.length === 2 && path[0]!.text === "self") {
const field = path[1]!.text;
if (
sctx.requiredFields.findIndex((v) => v === field) >=
0
) {
sctx = removeRequiredVariable(field, sctx);
}
}
}
break;
case "statement_augmentedassign":
{
// Process lvalue
const tempSctx = { ...sctx, requiredFields: [] };
ctx = resolveExpression(s.path, tempSctx, ctx);
const path = tryExtractPath(s.path);
if (path === null) {
throwCompilationError(
`Assignments are allowed only into path expressions, i.e. identifiers, or sequences of direct contract/struct/message accesses, like "self.foo" or "self.structure.field"`,
s.path.loc,
);
}
if (!isLvalue(path, ctx)) {
throwCompilationError(
"Modifications of constant expressions are not allowed",
s.path.loc,
);
}
// Process expression
ctx = resolveExpression(s.expression, sctx, ctx);
// Check type
const tailType = getExpType(ctx, s.path);
const expressionType = getExpType(ctx, s.expression);
// Check if any of the types is not ref or is optional or types themselves don't match
if (tailType.kind !== "ref" || tailType.optional) {
throwCompilationError(
`Type error: invalid type ${printTypeRef(tailType)} for augmented assignment`,
s.path.loc,
);
}
if (
expressionType.kind !== "ref" ||
expressionType.optional
) {
throwCompilationError(
`Type error: invalid type ${printTypeRef(expressionType)} for augmented assignment`,
s.expression.loc,
);
}
if (s.op === "&&" || s.op === "||") {
if (tailType.name !== "Bool") {
throwCompilationError(
`Type error: Augmented assignment ${s.op}= is only allowed for Bool type`,
s.path.loc,
);
}
if (expressionType.name !== "Bool") {
throwCompilationError(
`Type error: Augmented assignment ${s.op}= is only allowed for Bool type`,
s.expression.loc,
);
}
} else {
if (tailType.name !== "Int") {
throwCompilationError(
`Type error: Augmented assignment ${s.op}= is only allowed for Int type`,
s.path.loc,
);
}
if (expressionType.name !== "Int") {
throwCompilationError(
`Type error: Augmented assignment ${s.op}= is only allowed for Int type`,
s.expression.loc,
);
}
}
}
break;
case "statement_expression":
{
// Process expression
ctx = resolveExpression(s.expression, sctx, ctx);
// take `throw` and `throwNative` into account when doing
// return-reachability analysis
if (
s.expression.kind === "static_call" &&
["throw", "nativeThrow"].includes(
idText(s.expression.function),
)
) {
returnAlwaysReachable = true;
}
}
break;
case "statement_condition":
{
// Process condition (expression resolved inside)
const r = processCondition(s, sctx, ctx);
ctx = r.ctx;
sctx = r.sctx;
returnAlwaysReachable ||= r.returnAlwaysReachable;
// Check type
const expressionType = getExpType(ctx, s.condition);
if (
expressionType.kind !== "ref" ||
expressionType.name !== "Bool" ||
expressionType.optional
) {
throwCompilationError(
`Type mismatch: "${printTypeRef(expressionType)}" is not assignable to "Bool"`,
s.loc,
);
}
}
break;
case "statement_return":
{
if (s.expression) {
// Process expression
ctx = resolveExpression(s.expression, sctx, ctx);
// Check type
const expressionType = getExpType(ctx, s.expression);
// Actually, we might relax the following restriction in the future
// Because `return foo()` means `foo(); return` for a void-returning function
// And `return foo()` looks nicer when the user needs early exit from a function
// right after executing `foo()`
if (expressionType.kind == "void") {
throwCompilationError(
`'return' statement can only be used with non-void types`,
s.loc,
);
}
if (!isAssignable(expressionType, sctx.returns)) {
throwCompilationError(
`Type mismatch: "${printTypeRef(expressionType)}" is not assignable to "${printTypeRef(sctx.returns)}"`,
s.loc,
);
}
} else {
if (sctx.returns.kind !== "void") {
throwCompilationError(
`The function fails to return a result of type "${printTypeRef(sctx.returns)}"`,
s.loc,
);
}
}
// Check if all required variables are assigned
if (sctx.requiredFields.length > 0) {
if (sctx.requiredFields.length === 1) {
throwCompilationError(
`Field "${sctx.requiredFields[0]}" is not set`,
sctx.root,
);
} else {
throwCompilationError(
`Fields ${sctx.requiredFields.map((x) => '"' + x + '"').join(", ")} are not set`,
sctx.root,
);
}
}
returnAlwaysReachable = true;
}
break;
case "statement_repeat":
{
// Process expression
ctx = resolveExpression(s.iterations, sctx, ctx);
// Process statements
const r = processStatements(s.statements, sctx, ctx);
ctx = r.ctx;
// Check type
const expressionType = getExpType(ctx, s.iterations);
if (
expressionType.kind !== "ref" ||
expressionType.name !== "Int" ||
expressionType.optional
) {
throwCompilationError(
`Type mismatch: "${printTypeRef(expressionType)}" is not assignable to "Int"`,
s.loc,
);
}
}
break;
case "statement_until":
{
// Process expression
ctx = resolveExpression(s.condition, sctx, ctx);
// Process statements
const r = processStatements(s.statements, sctx, ctx);
ctx = r.ctx;
// XXX a do-until loop is a weird place to always return from a function
// so we might want to issue a warning here
returnAlwaysReachable ||= r.returnAlwaysReachable;
// Check type
const expressionType = getExpType(ctx, s.condition);
if (
expressionType.kind !== "ref" ||
expressionType.name !== "Bool" ||
expressionType.optional
) {
throwCompilationError(
`Type mismatch: "${printTypeRef(expressionType)}" is not assignable to "Bool"`,
s.loc,
);
}
}
break;
case "statement_while":
{
// Process expression
ctx = resolveExpression(s.condition, sctx, ctx);
// Process statements
const r = processStatements(s.statements, sctx, ctx);
ctx = r.ctx;
// a while loop might be executed zero times, so
// even if its body always returns from a function
// we don't care
// Check type
const expressionType = getExpType(ctx, s.condition);
if (
expressionType.kind !== "ref" ||
expressionType.name !== "Bool" ||
expressionType.optional
) {
throwCompilationError(
`Type mismatch: "${printTypeRef(expressionType)}" is not assignable to "Bool"`,
s.loc,
);
}
}
break;
case "statement_try":
{
// Process inner statements
const r = processStatements(s.statements, sctx, ctx);
ctx = r.ctx;
sctx = r.sctx;
// try-statement might not return from the current function
// because the control flow can go to the empty catch block
}
break;
case "statement_try_catch":
{
let initialSctx = sctx;
// Process inner statements
const r = processStatements(s.statements, sctx, ctx);
ctx = r.ctx;
let catchCtx = sctx;
// Process catchName variable for exit code
checkVariableExists(ctx, initialSctx, s.catchName);
catchCtx = addVariable(
s.catchName,
{ kind: "ref", name: "Int", optional: false },
ctx,
initialSctx,
);
// Process catch statements
const rCatch = processStatements(
s.catchStatements,
catchCtx,
ctx,
);
ctx = rCatch.ctx;
catchCtx = rCatch.sctx;
// if both catch- and try- blocks always return from the current function
// we mark the whole try-catch statement as always returning
returnAlwaysReachable ||=
r.returnAlwaysReachable && rCatch.returnAlwaysReachable;
// Merge statement contexts
const removed: string[] = [];
for (const f of initialSctx.requiredFields) {
if (!catchCtx.requiredFields.find((v) => v === f)) {
removed.push(f);
}
}
for (const r of removed) {
initialSctx = removeRequiredVariable(r, initialSctx);
}
}
break;
case "statement_foreach": {
let initialSctx = sctx; // Preserve initial context to use later for merging
// Resolve map expression
ctx = resolveExpression(s.map, sctx, ctx);
const mapPath = tryExtractPath(s.map);
if (mapPath === null) {
throwCompilationError(
`foreach is only allowed over maps that are path expressions, i.e. identifiers, or sequences of direct contract/struct/message accesses, like "self.foo" or "self.structure.field"`,
s.map.loc,
);
}
// Check if map is valid
const mapType = getExpType(ctx, s.map);
if (mapType.kind !== "map") {
throwCompilationError(
`foreach can only be used on maps, but "${mapPath.map((id) => id.text).join(".")}" has type "${printTypeRef(mapType)}"`,
s.map.loc,
);
}
let foreachSctx = sctx;
// Add key and value to statement context
if (!isWildcard(s.keyName)) {
checkVariableExists(ctx, initialSctx, s.keyName);
foreachSctx = addVariable(
s.keyName,
{ kind: "ref", name: mapType.key, optional: false },
ctx,
initialSctx,
);
}
if (!isWildcard(s.valueName)) {
checkVariableExists(ctx, foreachSctx, s.valueName);
foreachSctx = addVariable(
s.valueName,
{ kind: "ref", name: mapType.value, optional: false },
ctx,
foreachSctx,
);
}
// Process inner statements
const r = processStatements(s.statements, foreachSctx, ctx);
ctx = r.ctx;
foreachSctx = r.sctx;
// Merge statement contexts (similar to catch block merging)
const removed: string[] = [];
for (const f of initialSctx.requiredFields) {
if (!foreachSctx.requiredFields.find((v) => v === f)) {
removed.push(f);
}
}
for (const r of removed) {
initialSctx = removeRequiredVariable(r, initialSctx);
}
sctx = initialSctx; // Re-assign the modified initial context back to sctx after merging
break;
}
case "statement_destruct": {
// Process expression
ctx = resolveExpression(s.expression, sctx, ctx);
// Check variable names
for (const [_, name] of s.identifiers.values()) {
checkVariableExists(ctx, sctx, name);
}
// Check type
const expressionType = getExpType(ctx, s.expression);
if (expressionType.kind !== "ref") {
throwCompilationError(
`Type '${printTypeRef(expressionType)}' cannot be destructured`,
s.expression.loc,
);
}
if (expressionType.optional) {
throwCompilationError(
`Type '${printTypeRef(expressionType)}' is optional and cannot be destructured`,
s.expression.loc,
);
}
const ty = getType(ctx, expressionType.name);
if (ty.kind !== "struct") {
throwCompilationError(
`Type '${printTypeRef(expressionType)}' cannot be destructured`,
s.expression.loc,
);
}
// Check variables count
if (
!s.ignoreUnspecifiedFields &&
s.identifiers.size !== ty.fields.length
) {
throwCompilationError(
`Expected ${ty.fields.length} fields, but got ${s.identifiers.size}`,
s.loc,
);
}
// Compare type with the specified one
const typeRef = resolveTypeRef(ctx, s.type);
if (typeRef.kind !== "ref") {
throwInternalCompilerError(
`Unexpected type kind: '${typeRef.kind}'`,
s.type.loc,
);
}
if (expressionType.name !== typeRef.name) {
throwCompilationError(
`Type mismatch: "${printTypeRef(expressionType)}" is not assignable to "${printTypeRef(typeRef)}"`,
s.expression.loc,
);
}
// Add variables
s.identifiers.forEach(([field, name], _) => {
const f = ty.fields.find((f) => eqNames(f.name, field));
if (!f) {
throwCompilationError(
`Field '${idTextErr(field)}' not found in type '${expressionType.name}'`,
field.loc,
);
}
if (name.text !== "_") {
sctx = addVariable(name, f.type, ctx, sctx);
}
});
break;
}
}
}
return { ctx, sctx, returnAlwaysReachable };
}
function processFunctionBody(
statements: AstStatement[],
sctx: StatementContext,
ctx: CompilerContext,
): CompilerContext {
const res = processStatements(statements, sctx, ctx);
// Check if a non-void function always returns a value
if (sctx.returns.kind !== "void" && !res.returnAlwaysReachable) {
throwCompilationError(
`Function does not always return a result. Adding 'return' statement(s) should fix the issue.`,
res.sctx.root,
);
}
// Check if all required variables are assigned
if (res.sctx.requiredFields.length > 0) {
if (res.sctx.requiredFields.length === 1) {
throwCompilationError(
`Field "${res.sctx.requiredFields[0]}" is not set`,
res.sctx.root,
);
} else {
throwCompilationError(
`Fields ${res.sctx.requiredFields.map((x) => '"' + x + '"').join(", ")} are not set`,
res.sctx.root,
);
}
}
return res.ctx;
}
export function resolveStatements(ctx: CompilerContext) {
// Process all static functions
for (const f of getAllStaticFunctions(ctx)) {
if (f.ast.kind === "function_def") {
// Build statement context
let sctx = emptyContext(f.ast.loc, f.name, f.returns);
for (const p of f.params) {
sctx = addVariable(p.name, p.type, ctx, sctx);
}
ctx = processFunctionBody(f.ast.statements, sctx, ctx);
}
}
// Process all types
for (const t of getAllTypes(ctx)) {
// Process init
if (t.init) {
// Build statement context
let sctx = emptyContext(t.init.ast.loc, null, { kind: "void" });
// Self
sctx = addVariable(
selfId,
{ kind: "ref", name: t.name, optional: false },
ctx,
sctx,
);
// Required variables
for (const f of t.fields) {
if (f.default !== undefined) {
// NOTE: undefined is important here
continue;
}
if (isAssignable({ kind: "null" }, f.type)) {
continue;
}
sctx = addRequiredVariables(f.name, sctx);
}
// Args
for (const p of t.init.params) {
sctx = addVariable(p.name, p.type, ctx, sctx);
}
// Process
ctx = processFunctionBody(t.init.ast.statements, sctx, ctx);
}
// Process receivers
for (const f of t.receivers) {
// Build statement context
let sctx = emptyContext(f.ast.loc, null, { kind: "void" });
sctx = addVariable(
selfId,
{ kind: "ref", name: t.name, optional: false },
ctx,
sctx,
);
switch (f.selector.kind) {
case "internal-binary":
case "external-binary":
{
sctx = addVariable(
f.selector.name,
{
kind: "ref",
name: f.selector.type,
optional: false,
},
ctx,
sctx,
);
}
break;
case "internal-empty":
case "external-empty":
case "external-comment":
case "internal-comment":
// Nothing to add to context
break;
case "internal-comment-fallback":
case "external-comment-fallback":
{
sctx = addVariable(
f.selector.name,
{ kind: "ref", name: "String", optional: false },
ctx,
sctx,
);
}
break;
case "internal-fallback":
case "external-fallback":
{
sctx = addVariable(
f.selector.name,
{ kind: "ref", name: "Slice", optional: false },
ctx,
sctx,
);
}
break;
case "bounce-fallback":
{
sctx = addVariable(
f.selector.name,
{ kind: "ref", name: "Slice", optional: false },
ctx,
sctx,
);
}
break;
case "bounce-binary":
{
sctx = addVariable(
f.selector.name,
f.selector.bounced
? { kind: "ref_bounced", name: f.selector.type }
: {
kind: "ref",
name: f.selector.type,
optional: false,
},
ctx,
sctx,
);
}
break;
}
// Process
ctx = processFunctionBody(f.ast.statements, sctx, ctx);
}
// Process functions
const methodIds: Map<number, string> = new Map();
for (const f of t.functions.values()) {
if (
f.ast.kind !== "native_function_decl" &&
f.ast.kind !== "function_decl" &&
f.ast.kind !== "asm_function_def"
) {
// Build statement context
let sctx = emptyContext(f.ast.loc, f.name, f.returns);
if (f.self === null) {
throwInternalCompilerError(
"Self is null where it should not be",
);
}
sctx = addVariable(selfId, f.self, ctx, sctx);
// Check for collisions in getter method IDs
if (f.isGetter) {
const methodId = getMethodId(f, ctx, sctx);
const existing = methodIds.get(methodId);
if (existing) {
throwCompilationError(
`Method ID collision: getter '${f.name}' has the same method ID ${methodId} as getter '${existing}'\nPick a different getter name or explicit method ID to avoid collisions`,
f.ast.name.loc,
);
} else {
f.methodId = methodId;
methodIds.set(methodId, f.name);
}
}
for (const a of f.params) {
sctx = addVariable(a.name, a.type, ctx, sctx);
}
ctx = processFunctionBody(f.ast.statements, sctx, ctx);
}
}
}
return ctx;
}
function checkMethodId(methodId: bigint, loc: SrcInfo) {
// method ids are 19-bit signed integers
if (methodId < -(2n ** 18n) || methodId >= 2n ** 18n) {
throwConstEvalError(
"method ids must fit 19-bit signed integer range",
true,
loc,
);
}
// method ids -4, -3, -2, -1, 0 ... 2^14 - 1 (inclusive) are kind of reserved by TVM
// for the upper bound see F12_n (CALL) TVM instruction
// and many small ids will be taken by internal procedures
//
// also, some ids are taken by the getters generated by Tact:
// supported_interfaces -> 113617
// lazy_deployment_completed -> 115390
// get_abi_ipfs -> 121275
if (-4n <= methodId && methodId < 2n ** 14n) {
throwConstEvalError(
"method ids cannot overlap with the TVM reserved ids: -4, -3, -2, -1, 0 ... 2^14 - 1",