rev: eeadb6082f44956592d11d79c659cb265ac9d9d3 scopes/src/value.hpp -rw-r--r-- 41.6 KiB View raw Log this file
eeadb6082f44 — Leonard Ritter * SPIR-V: fixed unstructured branch validation error for `if/elseif/else` construct 9 days ago
                                                                                
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
/*
    The Scopes Compiler Infrastructure
    This file is distributed under the MIT License.
    See LICENSE.md for details.
*/

#ifndef SCOPES_VALUE_HPP
#define SCOPES_VALUE_HPP

#include "symbol.hpp"
#include "result.hpp"
#include "builtin.hpp"
#include "type.hpp"
#include "value_kind.hpp"
#include "valueref.inc"

#include "qualifier/unique_qualifiers.hpp"

#include <vector>
#include <unordered_map>
#include <unordered_set>

namespace scopes {

// untyped, instructions, functions
#define SCOPES_DEFINITION_ANCHOR_API() \
    const Anchor *def_anchor() const; \
    void set_def_anchor(const Anchor *anchor); \
protected: const Anchor *_def_anchor = nullptr; \
public: \


struct Anchor;
struct List;
struct Scope;
struct Block;

typedef std::vector<ParameterRef> Parameters;
typedef std::vector<ParameterTemplateRef> ParameterTemplates;
typedef std::vector<ValueRef> Values;
typedef std::vector<TypedValueRef> TypedValues;
typedef std::vector<InstructionRef> Instructions;
typedef std::vector<ConstRef> Constants;
typedef std::vector<Const *> ConstantPtrs;
typedef std::vector<MergeRef> Merges;
typedef std::vector<RepeatRef> Repeats;
typedef std::vector<ReturnRef> Returns;
typedef std::vector<RaiseRef> Raises;
typedef std::vector<Block *> Blocks;

const char *get_value_kind_name(ValueKind kind);
const char *get_value_class_name(ValueKind kind);

//------------------------------------------------------------------------------

struct ValueIndex {
    struct Hash {
        std::size_t operator()(const ValueIndex & s) const;
    };
    typedef std::unordered_set<ValueIndex, ValueIndex::Hash> Set;

    ValueIndex(const TypedValueRef &_value, int _index = 0);
    bool operator ==(const ValueIndex &other) const;

    const Type *get_type() const;

    TypedValueRef value;
    int index;
};

typedef ValueIndex::Set ValueIndexSet;
typedef std::vector<ValueIndex> ValueIndices;

//------------------------------------------------------------------------------

struct Value {
    ValueKind kind() const;

    Value(ValueKind _kind);
    Value(const Value &other) = delete;

    bool is_accessible() const;
    int get_depth() const;

private:
    const ValueKind _kind;
};

const Anchor *get_best_anchor(const ValueRef &value);
void set_best_anchor(const ValueRef &value, const Anchor *anchor);

//------------------------------------------------------------------------------

struct UntypedValue : Value {
    static bool classof(const Value *T);

    UntypedValue(ValueKind _kind);
};

//------------------------------------------------------------------------------

struct TypedValue : Value {
    static bool classof(const Value *T);

    TypedValue(ValueKind _kind, const Type *type);

    //bool is_typed() const;
    const Type *get_type() const;
    void hack_change_value(const Type *T);

protected:
    const Type *_type;
};

//------------------------------------------------------------------------------

struct Block {
    typedef std::unordered_map<TypedValue *, ConstRef> DataMap;

    Block();
    void append(const InstructionRef &node);
    bool empty() const;
    void migrate_from(Block &source);
    void clear();
    void set_parent(Block *parent);

    bool is_terminated() const;

    void insert_at(int index);
    void insert_at_end();

    bool is_valid(int id) const;
    bool is_valid(const IDSet &ids, int &id) const;
    bool is_valid(const ValueIndex &value, int &id) const;
    bool is_valid(const IDSet &ids) const;
    bool is_valid(const ValueIndex &value) const;
    void move(int id);

    DataMap &get_channel(Symbol name);

    std::unordered_map<Symbol, DataMap *, Symbol::Hash> channels;

    int depth;
    int insert_index;
    bool tag_traceback;
    Instructions body;
    InstructionRef terminator;
    // set of unique ids that are still valid in this scope
    IDSet valid;
};

//------------------------------------------------------------------------------

struct Instruction : TypedValue {
    static bool classof(const Value *T);

    Instruction(ValueKind _kind, const Type *type);

    Symbol name;
    Block *block;
};

void validate_instruction(const TypedValueRef &value);
void validate_instructions(const TypedValues &values);

//------------------------------------------------------------------------------

struct Terminator : Instruction {
    static bool classof(const Value *T);

    Terminator(ValueKind _kind, const TypedValues &_values);

    TypedValues values;
};

//------------------------------------------------------------------------------

struct KeyedTemplate : UntypedValue {
    static bool classof(const Value *T);

    KeyedTemplate(Symbol key, const ValueRef &node);

    static ValueRef from(Symbol key, ValueRef node);

    Symbol key;
    ValueRef value;
};

//------------------------------------------------------------------------------

struct Keyed : TypedValue {
    static bool classof(const Value *T);

    Keyed(const Type *type, Symbol key, const TypedValueRef &node);

    static TypedValueRef from(Symbol key, TypedValueRef node);

    Symbol key;
    TypedValueRef value;
};

//------------------------------------------------------------------------------

struct ArgumentListTemplate : UntypedValue {
    static bool classof(const Value *T);

    ArgumentListTemplate(const Values &values);

    //bool is_constant() const;
    bool empty() const;

    //static ValueRef empty_from();
    static ValueRef from(const Values &values = {});

    const Values &values() const;

protected:
    Values _values;
};

//------------------------------------------------------------------------------

const Type *arguments_type_from_typed_values(const TypedValues &_values);

struct ArgumentList : TypedValue {
    static bool classof(const Value *T);

    ArgumentList(const TypedValues &values);

    bool is_constant() const;

    static TypedValueRef from(const TypedValues &values);

    TypedValues values;
};

//------------------------------------------------------------------------------

struct ExtractArgumentTemplate : UntypedValue {
    static bool classof(const Value *T);

    ExtractArgumentTemplate(const ValueRef &value, int index, bool vararg);

    static ValueRef from(const ValueRef &value, int index, bool vararg = false);

    int index;
    ValueRef value;
    bool vararg;
};

//------------------------------------------------------------------------------

struct ExtractArgument : TypedValue {
    static bool classof(const Value *T);

    ExtractArgument(const Type *type, const TypedValueRef &value, int index);

    static TypedValueRef variadic_from(const TypedValueRef &value, int index);
    static TypedValueRef from(const TypedValueRef &value, int index);

    int index;
    TypedValueRef value;
};

//------------------------------------------------------------------------------

struct Pure : TypedValue {
    static bool classof(const Value *T);

    bool key_equal(const Pure *other) const;
    std::size_t hash() const;

    Pure(ValueKind _kind, const Type *type);
};

//------------------------------------------------------------------------------

struct Template : UntypedValue {
    static bool classof(const Value *T);

    Template(Symbol name, const ParameterTemplates &params, const ValueRef &value);

    bool is_forward_decl() const;
    void set_inline();
    bool is_inline() const;
    void append_param(const ParameterTemplateRef &sym);
    bool is_hidden() const;

    static TemplateRef from(Symbol name, const ParameterTemplates &params = {},
        const ValueRef &value = ValueRef());

    Symbol name;
    ParameterTemplates params;
    ValueRef value;
    bool _is_inline;
    const String *docstring;
    int recursion;
    SCOPES_DEFINITION_ANCHOR_API()
};

//------------------------------------------------------------------------------

struct Expression : UntypedValue {
    static bool classof(const Value *T);

    Expression(const Values &nodes, const ValueRef &value);
    void append(const ValueRef &node);

    static ExpressionRef scoped_from(const Values &nodes = {}, const ValueRef &value = ValueRef());
    static ExpressionRef unscoped_from(const Values &nodes = {}, const ValueRef &value = ValueRef());

    Values body;
    ValueRef value;
    bool scoped;
};

//------------------------------------------------------------------------------

struct CondBr : Instruction {
    static bool classof(const Value *T);

    CondBr(const TypedValueRef &cond);

    static CondBrRef from(const TypedValueRef &cond);

    TypedValueRef cond;
    Block then_body;
    Block else_body;
};

//------------------------------------------------------------------------------

struct CondTemplate : UntypedValue {
    static bool classof(const Value *T);

    CondTemplate(const ValueRef &cond, const ValueRef &then_value, const ValueRef &else_value);

    static CondTemplateRef from(const ValueRef &cond, const ValueRef &then_value, const ValueRef &else_value);

    ValueRef cond;
    ValueRef then_value;
    ValueRef else_value;
};

//------------------------------------------------------------------------------

enum CaseKind {
    CK_Case = 0,
    CK_Pass,
    CK_Do,
    CK_Default
};

struct SwitchTemplate : UntypedValue {
    struct Case {
        const Anchor *anchor;
        CaseKind kind;
        ValueRef literal;
        ValueRef value;

        Case() : anchor(nullptr), kind(CK_Case) {}
    };

    typedef std::vector<Case> Cases;

    static bool classof(const Value *T);

    SwitchTemplate(const ValueRef &expr, const Cases &cases);

    static SwitchTemplateRef from(const ValueRef &expr = ValueRef(), const Cases &cases = {});

    void append_case(const ValueRef &literal, const ValueRef &value);
    void append_pass(const ValueRef &literal, const ValueRef &value);
    void append_do(const ValueRef &value);
    void append_default(const ValueRef &value);

    ValueRef expr;
    Cases cases;
};

//------------------------------------------------------------------------------

struct Switch : Instruction {
    struct Case {
        const Anchor *anchor;
        CaseKind kind;
        ConstIntRef literal;
        Block body;

        Case() : anchor(nullptr), kind(CK_Case) {}
    };

    typedef std::vector<Case *> Cases;

    static bool classof(const Value *T);

    Switch(const TypedValueRef &expr, const Cases &cases);

    static SwitchRef from(const TypedValueRef &expr = TypedValueRef(), const Cases &cases = {});

    Case &append_pass(const Anchor *anchor, const ConstIntRef &literal);
    Case &append_default(const Anchor *anchor);

    TypedValueRef expr;
    Cases cases;
};

//------------------------------------------------------------------------------

struct ParameterTemplate : UntypedValue {
    static bool classof(const Value *T);

    ParameterTemplate(Symbol name, bool variadic);
    static ParameterTemplateRef from(Symbol name = SYM_Unnamed);
    static ParameterTemplateRef variadic_from(Symbol name = SYM_Unnamed);

    bool is_variadic() const;
    void set_owner(const TemplateRef &_owner, int _index);

    Symbol name;
    bool variadic;
    TemplateRef owner;
    int index;
};

//------------------------------------------------------------------------------

struct Parameter : TypedValue {
    static bool classof(const Value *T);

    Parameter(Symbol name, const Type *type);
    static ParameterRef from(Symbol name, const Type *type);

    void set_owner(const FunctionRef &_owner, int _index);

    void retype(const Type *T);

    Symbol name;
    FunctionRef owner;
    Block *block;
    int index;
};

//------------------------------------------------------------------------------

struct LoopArguments : UntypedValue {
    static bool classof(const Value *T);

    LoopArguments(const LoopRef &loop);
    static LoopArgumentsRef from(const LoopRef &loop);

    LoopRef loop;
};

//------------------------------------------------------------------------------

struct LoopLabelArguments : TypedValue {
    static bool classof(const Value *T);

    LoopLabelArguments(const Type *type);
    static LoopLabelArgumentsRef from(const Type *type);

    LoopLabelRef loop;
};

//------------------------------------------------------------------------------

struct Exception : TypedValue {
    static bool classof(const Value *T);

    Exception(const Type *type);
    static ExceptionRef from(const Type *type);
};

//------------------------------------------------------------------------------

#define SCOPES_LABEL_KIND() \
    /* an user-created label */ \
    T(LK_User, "label") \
    /* the return label of an inline function */ \
    T(LK_Inline, "inline") \
    /* the try block of a try/except construct */ \
    T(LK_Try, "try") \
    /* the except block of a try/except construct */ \
    T(LK_Except, "except") \
    /* the else block of a try/else construct */ \
    T(LK_ExceptAll, "except-all") \
    /* a break label of a loop */ \
    T(LK_Break, "break") \
    /* a merge label of a branch */ \
    T(LK_BranchMerge, "branch") \

enum LabelKind {
#define T(NAME, BNAME) \
    NAME,
SCOPES_LABEL_KIND()
#undef T
};

struct Label : Instruction {
    static bool classof(const Value *T);

    Label(LabelKind kind, Symbol name);

    static LabelRef from(LabelKind kind, Symbol name = SYM_Unnamed);
    void change_type(const Type *type);

    Symbol name;
    Block body;
    Merges merges;
    LabelKind label_kind;
    std::unordered_set<TypedValue *> splitpoints;
};

const char *get_label_kind_name(LabelKind kind);

//------------------------------------------------------------------------------

struct LabelTemplate : UntypedValue {
    static bool classof(const Value *T);

    LabelTemplate(LabelKind kind, Symbol name, const ValueRef &value);

    static LabelTemplateRef from(LabelKind kind, Symbol name = SYM_Unnamed,
        const ValueRef &value = ValueRef());
    static LabelTemplateRef try_from(const ValueRef &value = ValueRef());
    static LabelTemplateRef except_from(const ValueRef &value = ValueRef());
    static LabelTemplateRef except_all_from(const ValueRef &value = ValueRef());

    Symbol name;
    ValueRef value;
    LabelKind label_kind;
};

//------------------------------------------------------------------------------

enum CallFlags {
    CF_RawCall = (1 << 0),
};

struct CallTemplate : UntypedValue {
    static bool classof(const Value *T);

    CallTemplate(const ValueRef &callee, const Values &args);
    static CallTemplateRef from(const ValueRef &callee, const Values &args = {});
    bool is_rawcall() const;
    void set_rawcall();

    ValueRef callee;
    Values args;
    uint32_t flags;
};

//------------------------------------------------------------------------------

#define SCOPES_CAST_KIND() \
    T(CastBitcast, "cast-kind-bitcast") \
    T(CastIntToPtr, "cast-kind-inttoptr") \
    T(CastPtrToInt, "cast-kind-ptrotint") \
    T(CastSExt, "cast-kind-sext") \
    T(CastITrunc, "cast-kind-itrunc") \
    T(CastZExt, "cast-kind-zext") \
    T(CastFPTrunc, "cast-kind-fptrunc") \
    T(CastFPExt, "cast-kind-fpext") \
    T(CastFPToUI, "cast-kind-fptoui") \
    T(CastFPToSI, "cast-kind-fptosi") \
    T(CastUIToFP, "cast-kind-uitofp") \
    T(CastSIToFP, "cast-kind-sitofp") \
    T(CastPtrToRef, "cast-kind-ptrtoref") \
    T(CastRefToPtr, "cast-kind-reftoptr") \


enum CastKind {
#define T(NAME, BNAME) NAME,
SCOPES_CAST_KIND()
#undef T
};

struct Cast : Instruction {
    static bool classof(const Value *T);

    Cast(CastKind _op, const TypedValueRef &_value, const Type *_type);
    static CastRef from(CastKind op, const TypedValueRef &value, const Type *type);

    CastKind op;
    TypedValueRef value;
};

//------------------------------------------------------------------------------

#define SCOPES_ICMP_KIND() \
    T(ICmpEQ, "icmp-kind-eq") \
    T(ICmpNE, "icmp-kind-ne") \
    T(ICmpUGT, "icmp-kind-ugt") \
    T(ICmpUGE, "icmp-kind-uge") \
    T(ICmpULT, "icmp-kind-ult") \
    T(ICmpULE, "icmp-kind-ule") \
    T(ICmpSGT, "icmp-kind-sgt") \
    T(ICmpSGE, "icmp-kind-sge") \
    T(ICmpSLT, "icmp-kind-slt") \
    T(ICmpSLE, "icmp-kind-sle") \

enum ICmpKind {
#define T(NAME, BNAME) NAME,
SCOPES_ICMP_KIND()
#undef T
};

#define SCOPES_FCMP_KIND() \
    T(FCmpOEQ, "fcmp-kind-oeq") \
    T(FCmpONE, "fcmp-kind-one") \
    T(FCmpORD, "fcmp-kind-ord") \
    T(FCmpOGT, "fcmp-kind-ogt") \
    T(FCmpOGE, "fcmp-kind-oge") \
    T(FCmpOLT, "fcmp-kind-olt") \
    T(FCmpOLE, "fcmp-kind-ole") \
    T(FCmpUEQ, "fcmp-kind-ueq") \
    T(FCmpUNE, "fcmp-kind-une") \
    T(FCmpUNO, "fcmp-kind-uno") \
    T(FCmpUGT, "fcmp-kind-ugt") \
    T(FCmpUGE, "fcmp-kind-uge") \
    T(FCmpULT, "fcmp-kind-ult") \
    T(FCmpULE, "fcmp-kind-ule") \

enum FCmpKind {
#define T(NAME, BNAME) NAME,
SCOPES_FCMP_KIND()
#undef T
};

struct ICmp : Instruction {
    static bool classof(const Value *T);

    ICmp(ICmpKind cmp_kind, const TypedValueRef &value1, const TypedValueRef &value2);
    static ICmpRef from(ICmpKind cmp_kind, const TypedValueRef &value1, const TypedValueRef &value2);
    ICmpKind cmp_kind;
    TypedValueRef value1;
    TypedValueRef value2;
};

struct FCmp : Instruction {
    static bool classof(const Value *T);

    FCmp(FCmpKind cmp_kind, const TypedValueRef &value1, const TypedValueRef &value2);
    static FCmpRef from(FCmpKind cmp_kind, const TypedValueRef &value1, const TypedValueRef &value2);
    FCmpKind cmp_kind;
    TypedValueRef value1;
    TypedValueRef value2;
};

//------------------------------------------------------------------------------

#define SCOPES_UNOP_KIND() \
    T(UnOpSin, "unop-kind-sin") \
    T(UnOpCos, "unop-kind-cos") \
    T(UnOpTan, "unop-kind-tan") \
    T(UnOpAsin, "unop-kind-asin") \
    T(UnOpAcos, "unop-kind-acos") \
    T(UnOpAtan, "unop-kind-atan") \
    T(UnOpSinh, "unop-kind-sinh") \
    T(UnOpCosh, "unop-kind-cosh") \
    T(UnOpTanh, "unop-kind-tanh") \
    T(UnOpASinh, "unop-kind-asinh") \
    T(UnOpACosh, "unop-kind-acosh") \
    T(UnOpATanh, "unop-kind-atanh") \
    T(UnOpTrunc, "unop-kind-trunc") \
    T(UnOpFloor, "unop-kind-floor") \
    T(UnOpFAbs, "unop-kind-fabs") \
    T(UnOpFSign, "unop-kind-fsign") \
    T(UnOpLog, "unop-kind-log") \
    T(UnOpLog2, "unop-kind-log2") \
    T(UnOpExp, "unop-kind-exp") \
    T(UnOpExp2, "unop-kind-exp2") \
    T(UnOpSqrt, "unop-kind-sqrt") \
    T(UnOpRadians, "unop-kind-radians") \
    T(UnOpDegrees, "unop-kind-degrees") \
    T(UnOpLength, "unop-kind-length") \
    T(UnOpNormalize, "unop-kind-normalize") \


enum UnOpKind {
#define T(NAME, BNAME) NAME,
SCOPES_UNOP_KIND()
#undef T
};

#define SCOPES_BINOP_KIND() \
    T(BinOpAdd, "binop-kind-add") \
    T(BinOpAddNUW, "binop-kind-add-nuw") \
    T(BinOpAddNSW, "binop-kind-add-nsw") \
    T(BinOpSub, "binop-kind-sub") \
    T(BinOpSubNUW, "binop-kind-sub-nuw") \
    T(BinOpSubNSW, "binop-kind-sub-nsw") \
    T(BinOpMul, "binop-kind-mul") \
    T(BinOpMulNUW, "binop-kind-mul-nuw") \
    T(BinOpMulNSW, "binop-kind-mul-nsw") \
    T(BinOpUDiv, "binop-kind-udiv") \
    T(BinOpSDiv, "binop-kind-sdiv") \
    T(BinOpURem, "binop-kind-urem") \
    T(BinOpSRem, "binop-kind-srem") \
    T(BinOpShl, "binop-kind-shl") \
    T(BinOpLShr, "binop-kind-lshr") \
    T(BinOpAShr, "binop-kind-ashr") \
    T(BinOpBAnd, "binop-kind-band") \
    T(BinOpBOr, "binop-kind-bor") \
    T(BinOpBXor, "binop-kind-bxor") \
    T(BinOpFAdd, "binop-kind-fadd") \
    T(BinOpFSub, "binop-kind-fsub") \
    T(BinOpFMul, "binop-kind-fmul") \
    T(BinOpFDiv, "binop-kind-fdiv") \
    T(BinOpFRem, "binop-kind-frem") \
    T(BinOpAtan2, "binop-kind-atan2") \
    T(BinOpCross, "binop-kind-cross") \
    T(BinOpStep, "binop-kind-step") \
    T(BinOpPow, "binop-kind-pow") \


enum BinOpKind {
#define T(NAME, BNAME) NAME,
SCOPES_BINOP_KIND()
#undef T
};

#define SCOPES_TRIOP_KIND() \
    T(TriOpFMix, "triop-kind-fmix") \


enum TriOpKind {
#define T(NAME, BNAME) NAME,
SCOPES_TRIOP_KIND()
#undef T
};

struct UnOp : Instruction {
    static bool classof(const Value *T);

    UnOp(UnOpKind op, const TypedValueRef &value);
    static UnOpRef from(UnOpKind op, const TypedValueRef &value);
    UnOpKind op;
    TypedValueRef value;
};

struct BinOp : Instruction {
    static bool classof(const Value *T);

    BinOp(BinOpKind op, const TypedValueRef &value1, const TypedValueRef &value2);
    static BinOpRef from(BinOpKind op, const TypedValueRef &value1, const TypedValueRef &value2);
    BinOpKind op;
    TypedValueRef value1;
    TypedValueRef value2;
};

struct TriOp : Instruction {
    static bool classof(const Value *T);

    TriOp(TriOpKind op, const TypedValueRef &value1, const TypedValueRef &value2, const TypedValueRef &value3);
    static TriOpRef from(TriOpKind op, const TypedValueRef &value1, const TypedValueRef &value2, const TypedValueRef &value3);
    TriOpKind op;
    TypedValueRef value1;
    TypedValueRef value2;
    TypedValueRef value3;
};

//------------------------------------------------------------------------------

struct Sample : Instruction {
    typedef std::pair<Symbol, TypedValueRef> Option;
    typedef std::vector<Option> Options;

    static bool classof(const Value *T);

    Sample(const TypedValueRef &_sampler, const TypedValueRef &_coords, const std::vector<Option> &_options);
    static SampleRef from(const TypedValueRef &sampler, const TypedValueRef &coords, const std::vector<Option> &options);

    TypedValueRef sampler;
    TypedValueRef coords;
    std::vector<Option> options;
};

struct ImageQuerySize : Instruction {
    static bool classof(const Value *T);

    ImageQuerySize(const TypedValueRef &_sampler, const TypedValueRef &_lod);
    bool has_lod() const;
    static ImageQuerySizeRef from(const TypedValueRef &sampler);
    static ImageQuerySizeRef from(const TypedValueRef &sampler, const TypedValueRef &lod);

    TypedValueRef sampler;
    TypedValueRef lod;
};

struct ImageQueryLod : Instruction {
    static bool classof(const Value *T);

    ImageQueryLod(const TypedValueRef &_sampler, const TypedValueRef &_coords);
    static ImageQueryLodRef from(const TypedValueRef &sampler, const TypedValueRef &coords);

    TypedValueRef sampler;
    TypedValueRef coords;
};

struct ImageQueryLevels : Instruction {
    static bool classof(const Value *T);

    ImageQueryLevels(const TypedValueRef &_sampler);
    static ImageQueryLevelsRef from(const TypedValueRef &sampler);

    TypedValueRef sampler;
};

struct ImageQuerySamples : Instruction {
    static bool classof(const Value *T);

    ImageQuerySamples(const TypedValueRef &_sampler);
    static ImageQuerySamplesRef from(const TypedValueRef &sampler);

    TypedValueRef sampler;
};

struct ImageRead : Instruction {
    static bool classof(const Value *T);

    ImageRead(const TypedValueRef &_image, const TypedValueRef &_coords);
    static ImageReadRef from(const TypedValueRef &image, const TypedValueRef &coords);

    TypedValueRef image;
    TypedValueRef coords;
};

struct ImageWrite : Instruction {
    static bool classof(const Value *T);

    ImageWrite(const TypedValueRef &_image, const TypedValueRef &_coords, const TypedValueRef &_texel);
    static ImageWriteRef from(const TypedValueRef &image, const TypedValueRef &coords, const TypedValueRef &texel);

    TypedValueRef image;
    TypedValueRef coords;
    TypedValueRef texel;
};

struct ExecutionMode : Instruction {
    static bool classof(const Value *T);

    ExecutionMode(Symbol _mode, int v0, int v1, int v2);
    static ExecutionModeRef from(Symbol mode);
    static ExecutionModeRef from(Symbol mode, int v0);
    static ExecutionModeRef from(Symbol mode, int v0, int v1);
    static ExecutionModeRef from(Symbol mode, int v0, int v1, int v2);

    Symbol mode;
    int values[3];
};

//------------------------------------------------------------------------------

struct Annotate : Instruction {
    static bool classof(const Value *T);

    Annotate(const TypedValues &_values);
    static AnnotateRef from(const TypedValues &values);
    TypedValues values;
};

//------------------------------------------------------------------------------

struct Select : Instruction {
    static bool classof(const Value *T);

    Select(const TypedValueRef &cond,
        const TypedValueRef &value1, const TypedValueRef &value2);
    static SelectRef from(const TypedValueRef &cond,
        const TypedValueRef &value1, const TypedValueRef &value2);
    TypedValueRef cond;
    TypedValueRef value1;
    TypedValueRef value2;
};

//------------------------------------------------------------------------------

struct GetElementPtr : Instruction {
    static bool classof(const Value *T);

    GetElementPtr(const TypedValueRef &value, const TypedValues &indices);
    static GetElementPtrRef from(const TypedValueRef &value, const TypedValues &indices);
    TypedValueRef value;
    TypedValues indices;
};

//------------------------------------------------------------------------------

struct ExtractValue : Instruction {
    static bool classof(const Value *T);

    ExtractValue(const TypedValueRef &value, uint32_t index);
    static TypedValueRef from(const TypedValueRef &value, uint32_t index);
    TypedValueRef value;
    uint32_t index;
};

struct InsertValue : Instruction {
    static bool classof(const Value *T);

    InsertValue(const TypedValueRef &value, const TypedValueRef &element, uint32_t index);
    static TypedValueRef from(const TypedValueRef &value, const TypedValueRef &element, uint32_t index);
    TypedValueRef value;
    TypedValueRef element;
    uint32_t index;
};

//------------------------------------------------------------------------------

struct ExtractElement : Instruction {
    static bool classof(const Value *T);

    ExtractElement(const TypedValueRef &value, const TypedValueRef &index);
    static TypedValueRef from(const TypedValueRef &value, const TypedValueRef &index);
    TypedValueRef value;
    TypedValueRef index;
};

struct InsertElement : Instruction {
    static bool classof(const Value *T);

    InsertElement(const TypedValueRef &value, const TypedValueRef &element, const TypedValueRef &index);
    static TypedValueRef from(const TypedValueRef &value, const TypedValueRef &element, const TypedValueRef &index);
    TypedValueRef value;
    TypedValueRef element;
    TypedValueRef index;
};

struct ShuffleVector : Instruction {
    static bool classof(const Value *T);

    ShuffleVector(const TypedValueRef &v1, const TypedValueRef &v2, const std::vector<uint32_t> &mask);
    static ShuffleVectorRef from(const TypedValueRef &v1, const TypedValueRef &v2, const std::vector<uint32_t> &mask);
    TypedValueRef v1;
    TypedValueRef v2;
    std::vector<uint32_t> mask;
};

//------------------------------------------------------------------------------

struct Alloca : Instruction {
    static bool classof(const Value *T);

    Alloca(const Type *T, const TypedValueRef &count);
    static AllocaRef from(const Type *T);
    static AllocaRef from(const Type *T, const TypedValueRef &count);
    bool is_array() const;
    const Type *type;
    TypedValueRef count;
};

struct Malloc : Instruction {
    static bool classof(const Value *T);

    Malloc(const Type *T, const TypedValueRef &count);
    static MallocRef from(const Type *T);
    static MallocRef from(const Type *T, const TypedValueRef &count);
    bool is_array() const;
    const Type *type;
    TypedValueRef count;
};

struct Free : Instruction {
    static bool classof(const Value *T);

    Free(const TypedValueRef &value);
    static FreeRef from(const TypedValueRef &value);
    TypedValueRef value;
};

struct Load : Instruction {
    static bool classof(const Value *T);

    Load(const TypedValueRef &value, bool is_volatile);
    static LoadRef from(const TypedValueRef &value, bool is_volatile = false);
    TypedValueRef value;
    bool is_volatile;
};

struct Store : Instruction {
    static bool classof(const Value *T);

    Store(const TypedValueRef &value, const TypedValueRef &target, bool is_volatile);
    static StoreRef from(const TypedValueRef &value, const TypedValueRef &target, bool is_volatile = false);
    TypedValueRef value;
    TypedValueRef target;
    bool is_volatile;
};

#define SCOPES_ATOMICRMW_OP_KIND() \
    T(AtomicRMWOpXchg, OP_Xchg, "atomicrmw-kind-xchg") \
    T(AtomicRMWOpAdd, OP_Add, "atomicrmw-kind-add") \
    T(AtomicRMWOpSub, OP_Sub, "atomicrmw-kind-sub") \
    T(AtomicRMWOpAnd, OP_BAnd, "atomicrmw-kind-band") \
    T(AtomicRMWOpNAnd, OP_BNAnd, "atomicrmw-kind-bnand") \
    T(AtomicRMWOpOr, OP_BOr, "atomicrmw-kind-bor") \
    T(AtomicRMWOpXor, OP_BXor, "atomicrmw-kind-bxor") \
    T(AtomicRMWOpSMin, OP_SMin, "atomicrmw-kind-smin") \
    T(AtomicRMWOpSMax, OP_SMax, "atomicrmw-kind-smax") \
    T(AtomicRMWOpUMin, OP_UMin, "atomicrmw-kind-umin") \
    T(AtomicRMWOpUMax, OP_UMax, "atomicrmw-kind-umax") \
    T(AtomicRMWOpFAdd, OP_FAdd, "atomicrmw-kind-fadd") \
    T(AtomicRMWOpFSub, OP_FSub, "atomicrmw-kind-fsub") \


enum AtomicRMWOpKind {
#define T(NAME, OPNAME, BNAME) NAME,
SCOPES_ATOMICRMW_OP_KIND()
#undef T
};

struct AtomicRMW : Instruction {
    static bool classof(const Value *T);

    AtomicRMW(AtomicRMWOpKind op, const TypedValueRef &target, const TypedValueRef &value);
    static AtomicRMWRef from(AtomicRMWOpKind op, const TypedValueRef &target, const TypedValueRef &value);
    AtomicRMWOpKind op;
    TypedValueRef target;
    TypedValueRef value;
};

struct CmpXchg : Instruction {
    static bool classof(const Value *T);

    CmpXchg(const TypedValueRef &target, const TypedValueRef &cmp, const TypedValueRef &value);
    static CmpXchgRef from(const TypedValueRef &target, const TypedValueRef &cmp, const TypedValueRef &value);
    TypedValueRef target;
    TypedValueRef cmp;
    TypedValueRef value;
};


#define SCOPES_BARRIER_KIND() \
    T(BarrierControl, "barrier-kind-control") \
    T(BarrierMemory, "barrier-kind-memory") \
    T(BarrierMemoryGroup, "barrier-kind-memory-group") \
    T(BarrierMemoryImage, "barrier-kind-memory-image") \
    T(BarrierMemoryBuffer, "barrier-kind-memory-buffer") \
    T(BarrierMemoryShared, "barrier-kind-memory-shared") \


enum BarrierKind {
#define T(NAME, BNAME) NAME,
SCOPES_BARRIER_KIND()
#undef T
};

struct Barrier : Instruction {
    static bool classof(const Value *T);

    Barrier(BarrierKind _kind);
    static BarrierRef from(BarrierKind kind);
    BarrierKind kind;
};

//------------------------------------------------------------------------------

struct PtrToRef {
    static CastRef from(const TypedValueRef &value);
};
struct RefToPtr {
    static CastRef from(const TypedValueRef &value);
};

//------------------------------------------------------------------------------

struct Call : Instruction {
    static bool classof(const Value *T);

    Call(const Type *type, const TypedValueRef &callee, const TypedValues &args);
    static CallRef from(const Type *type, const TypedValueRef &callee, const TypedValues &args = {});

    TypedValueRef callee;
    TypedValues args;
    Block except_body;
    ExceptionRef except;
};

//------------------------------------------------------------------------------

struct LoopLabel : Instruction {
    static bool classof(const Value *T);

    LoopLabel(const TypedValues &init, const LoopLabelArgumentsRef &args);

    static LoopLabelRef from(const TypedValues &init,
        const LoopLabelArgumentsRef &args);

    TypedValues init;
    Block body;
    Repeats repeats;
    LoopLabelArgumentsRef args;
};

//------------------------------------------------------------------------------

struct Loop : UntypedValue {
    static bool classof(const Value *T);

    Loop(const ValueRef &init, const ValueRef &value);

    static LoopRef from(const ValueRef &init = ValueRef(),
        const ValueRef &value = ValueRef());

    ValueRef init;
    ValueRef value;
    LoopArgumentsRef args;
};

//------------------------------------------------------------------------------

struct Const : Pure {
    static bool classof(const Value *T);

    Const(ValueKind _kind, const Type *type);
};

//------------------------------------------------------------------------------

struct Function : Pure {
    struct UniqueInfo {
        ValueIndex value;
        // at which block depth is the unique defined?
        int get_depth() const;

        UniqueInfo(const ValueIndex& value);
    };
    // map of known uniques within the function (any state)
    typedef std::unordered_map<int, UniqueInfo> UniqueMap;

    static bool classof(const Value *T);

    Function(Symbol name, const Parameters &params);

    static FunctionRef from(Symbol name,
        const Parameters &params);

    void append_param(const ParameterRef &sym);
    void change_type(const Type *type);
    void set_type(const Type *type);
    bool is_typed() const;

    bool key_equal(const Function *other) const;
    std::size_t hash() const;

    int unique_id();
    void bind_unique(const UniqueInfo &info);
    void try_bind_unique(const TypedValueRef &value);
    const UniqueInfo &get_unique_info(int id) const;
    void build_valids();

    Symbol name;
    Parameters params;
    Block body;
    const String *docstring;
    FunctionRef frame;
    FunctionRef boundary;
    TemplateRef original;
    LabelRef label;
    bool complete;
    int nextid;
    const Type *returning_hint;
    const Type *raising_hint;
    const Anchor *returning_anchor;
    const Anchor *raising_anchor;

    Types instance_args;
    void bind(const ValueRef &oldnode, const TypedValueRef &newnode);
    TypedValueRef unsafe_resolve(const ValueRef &node) const;
    TypedValueRef resolve_local(const ValueRef &node) const;
    SCOPES_RESULT(TypedValueRef) resolve(const ValueRef &node,
        const FunctionRef &boundary) const;
    std::unordered_map<Value *, TypedValueRef> map;
    Returns returns;
    Raises raises;

    UniqueMap uniques;
    IDSet original_valid;
    IDSet valid;
    // expressions that moved a unique
    std::unordered_map<int, ValueRef> movers;

    const Anchor *get_best_mover_anchor(int id);
    void hint_mover(int id, const ValueRef &where);
};

//------------------------------------------------------------------------------

struct ConstInt : Const {
    static bool classof(const Value *T);

    ConstInt(const Type *type, const std::vector<uint64_t> &value);

    bool key_equal(const ConstInt *other) const;
    std::size_t hash() const;

    static ConstIntRef from(const Type *type, uint64_t value);
    static ConstIntRef from(const Type *type, std::vector<uint64_t> value);
    static ConstIntRef symbol_from(Symbol value);
    static ConstIntRef builtin_from(Builtin value);

    std::vector<uint64_t> words;

    // return most significant word
    uint64_t msw() const;

    // assert and return single word
    uint64_t value() const;
};

//------------------------------------------------------------------------------

struct ConstReal : Const {
    static bool classof(const Value *T);

    ConstReal(const Type *type, double value);

    bool key_equal(const ConstReal *other) const;
    std::size_t hash() const;

    static ConstRealRef from(const Type *type, double value);

    double value;
};

//------------------------------------------------------------------------------

struct ConstAggregate : Const {
    static bool classof(const Value *T);

    ConstAggregate(const Type *type, const ConstantPtrs &fields);

    bool key_equal(const ConstAggregate *other) const;
    std::size_t hash() const;

    static ConstAggregateRef from(const Type *type, const ConstantPtrs &fields);
    static ConstAggregateRef none_from();
    static ConstAggregateRef ast_from(const ValueRef &node);

    ConstantPtrs values;
    std::size_t _hash;
};

ConstRef get_field(const ConstAggregateRef &value, uint32_t i);
ConstRef set_field(const ConstAggregateRef &value, const ConstRef &element, uint32_t i);

//------------------------------------------------------------------------------

struct ConstPointer : Const {
    static bool classof(const Value *T);

    ConstPointer(const Type *type, const void *pointer);

    bool key_equal(const ConstPointer *other) const;
    std::size_t hash() const;

    static ConstPointerRef from(const Type *type, const void *pointer);
    static ConstPointerRef type_from(const Type *type);
    static ConstPointerRef closure_from(const Closure *closure);
    static ConstPointerRef string_from(const String *str);
    static ConstPointerRef list_from(const List *list);
    static ConstPointerRef scope_from(const Scope *scope);
    static ConstPointerRef anchor_from(const Anchor *anchor);

    const void *value;
};

//------------------------------------------------------------------------------

#define SCOPES_GLOBAL_FLAGS() \
    /* if storage class is 'Uniform, the value is a SSBO */ \
    T(GF_BufferBlock, (1 << 0), "global-flag-buffer-block") \
    T(GF_NonWritable, (1 << 1), "global-flag-non-writable") \
    T(GF_NonReadable, (1 << 2), "global-flag-non-readable") \
    T(GF_Volatile, (1 << 3), "global-flag-volatile") \
    T(GF_Coherent, (1 << 4), "global-flag-coherent") \
    T(GF_Restrict, (1 << 5), "global-flag-restrict") \
    /* if storage class is 'Uniform, the value is a UBO */ \
    T(GF_Block, (1 << 6), "global-flag-block") \
    /* if storage class is 'Input or 'Output, the value is not to be interpolated */ \
    T(GF_Flat, (1 << 7), "global-flag-flat") \

enum GlobalFlags {
#define T(NAME, VALUE, SNAME) \
    NAME = VALUE,
SCOPES_GLOBAL_FLAGS()
#undef T
};

struct Global : Pure {
    static bool classof(const Value *T);

    Global(const Type *type, Symbol name,
        size_t flags, Symbol storage_class);

    bool key_equal(const Global *other) const;
    std::size_t hash() const;

    static GlobalRef from(const Type *type, Symbol name,
        size_t flags = 0,
        Symbol storage_class = SYM_Unnamed);

    const Type *element_type;
    PureRef initializer;
    FunctionRef constructor;
    Symbol name;
    size_t flags;
    Symbol storage_class;
    int location = -1;
    int binding = -1;
    int descriptor_set = -1;
};

//------------------------------------------------------------------------------

struct GlobalString : Pure {
    static bool classof(const Value *T);

    GlobalString(const char *_data, size_t _count);

    bool key_equal(const GlobalString *other) const;
    std::size_t hash() const;

    static GlobalStringRef from(const char *_data, size_t _count);

    std::string value;
};

//------------------------------------------------------------------------------

struct PureCast : Pure {
    static bool classof(const Value *T);

    bool key_equal(const PureCast *other) const;
    std::size_t hash() const;

    PureCast(const Type *type, const PureRef &value);
    static PureRef from(const Type *type, PureRef value);

    PureRef value;
};

//------------------------------------------------------------------------------

struct Undef : Pure {
    static bool classof(const Value *T);

    bool key_equal(const Undef *other) const;
    std::size_t hash() const;

    Undef(const Type *type);
    static UndefRef from(const Type *type);
};

//------------------------------------------------------------------------------

struct Merge : Terminator {
    static bool classof(const Value *T);

    Merge(const LabelRef &label, const TypedValues &values);

    static MergeRef from(const LabelRef &label, const TypedValues &values);

    LabelRef label;
};

//------------------------------------------------------------------------------

struct MergeTemplate : UntypedValue {
    static bool classof(const Value *T);

    MergeTemplate(const LabelTemplateRef &label, const ValueRef &value);

    static MergeTemplateRef from(const LabelTemplateRef &label, const ValueRef &value);

    LabelTemplateRef label;
    ValueRef value;
};

//------------------------------------------------------------------------------

struct Repeat : Terminator {
    static bool classof(const Value *T);

    Repeat(const LoopLabelRef &loop, const TypedValues &values);

    static RepeatRef from(const LoopLabelRef &loop, const TypedValues &values);

    LoopLabelRef loop;
};

//------------------------------------------------------------------------------

struct Return : Terminator {
    static bool classof(const Value *T);

    Return(const TypedValues &values);

    static ReturnRef from(const TypedValues &values);
};

//------------------------------------------------------------------------------

struct Raise : Terminator {
    static bool classof(const Value *T);

    Raise(const TypedValues &values);

    static RaiseRef from(const TypedValues &values);
};

//------------------------------------------------------------------------------

struct Unreachable : Terminator {
    static bool classof(const Value *T);

    Unreachable();
    static UnreachableRef from();
};

//------------------------------------------------------------------------------

struct Discard : Terminator {
    static bool classof(const Value *T);

    Discard();
    static DiscardRef from();
};

//------------------------------------------------------------------------------

struct Quote : UntypedValue {
    static bool classof(const Value *T);

    Quote(const ValueRef &value);

    static QuoteRef from(const ValueRef &value);

    ValueRef value;
};

//------------------------------------------------------------------------------

struct Unquote : UntypedValue {
    static bool classof(const Value *T);

    Unquote(const ValueRef &value);

    static UnquoteRef from(const ValueRef &value);

    ValueRef value;
};

//------------------------------------------------------------------------------

struct CompileStage : UntypedValue {
    static bool classof(const Value *T);

    CompileStage(const Anchor *anchor, const List *next, const Scope *env);

    static CompileStageRef from(const Anchor *anchor, const List *next, const Scope *env);

    const Anchor *anchor;
    const List *next;
    const Scope *env;
};

//------------------------------------------------------------------------------

struct Closure {
    Closure(const TemplateRef &_func, const FunctionRef &_frame);

    bool key_equal(const Closure *other) const;
    std::size_t hash() const;

    TemplateRef func;
    FunctionRef frame;

    static Closure *from(const TemplateRef &func, const FunctionRef &frame);

    StyledStream &stream(StyledStream &ost) const;
};

//------------------------------------------------------------------------------

} // namespace scopes

#endif // SCOPES_VALUE_HPP