-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathMetadataStructs.cs
1734 lines (1509 loc) · 52.6 KB
/
MetadataStructs.cs
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
using System;
using System.Collections.Generic;
using System.Linq;
using System.Reflection;
using System.Text;
// II.23 Metadata logical format: other structures
// CodeNode is written though reflection
#pragma warning disable 0649 // CS0649: Field '...' is never assigned to
[Ecma("II.23.1.1")]
enum AssemblyHashAlgorithm : uint
{
None = 0x0000,
Reserved_MD5 = 0x8003,
SHA1 = 0x8004,
}
[Ecma("II.23.1.2")]
[Flags]
enum AssemblyFlags : uint
{
[Description("The assembly reference holds the full (unhashed) public key.")]
PublicKey = 0x0001,
[Description("The implementation of this assembly used at runtime is not expected to match the version seen at compile time. (See the text following this table.)")]
Retargetable = 0x0100,
[Description("Reserved (a conforming implementation of the CLI can ignore this setting on read; some implementations might use this bit to indicate that a CIL-to-native-code compiler should not generate optimized code)")]
DisableJITcompileOptimizer = 0x4000,
[Description("Reserved (a conforming implementation of the CLI can ignore this setting on read; some implementations might use this bit to indicate that a CIL-to-native-code compiler should generate CIL-to-native code map)")]
EnableJITcompileTracking = 0x8000,
}
[Ecma("II.23.1.4")]
[Flags]
enum EventAttributes : ushort
{
[Description("Event is special")]
SpecialName = 0x0200,
[Description("CLI provides 'special' behavior, depending upon the name of the event")]
RTSpecialName = 0x0400,
}
[Ecma("II.23.1.5")]
sealed class FieldAttributes : CodeNode
{
// MAYBE add props for all the attrs below
public AccessAttributes Access { get; private set; }
public AdditionalFlags Flags { get; private set; }
protected override void InnerRead() {
var data = Bytes.Read<ushort>();
Access = (AccessAttributes)(data & accessMask);
Flags = (AdditionalFlags)(data & flagsMask);
}
public override string NodeValue => (new Enum[] { Access, Flags }).GetString();
public override string Description => string.Join("\n", Access.Describe().Concat(Flags.Describe()));
const ushort accessMask = 0x0007;
public enum AccessAttributes : ushort
{
[Description("Member not referenceable")]
CompilerControlled = 0x0000,
[Description("Accessible only by the parent type")]
Private = 0x0001,
[Description("Accessible by sub-types only in this Assembly")]
FamANDAssem = 0x0002,
[Description("Accessibly by anyone in the Assembly")]
Assembly = 0x0003,
[Description("Accessible only by type and sub-types")]
Family = 0x0004,
[Description("Accessibly by sub-types anywhere, plus anyone in assembly")]
FamORAssem = 0x0005,
[Description("Accessibly by anyone who has visibility to this scope field contract attributes")]
Public = 0x0006,
}
const ushort flagsMask = unchecked((ushort)~accessMask);
[Flags]
public enum AdditionalFlags : ushort
{
[Description("Defined on type, else per instance")]
Static = 0x0010,
[Description("Field can only be initialized, not written to after init")]
InitOnly = 0x0020,
[Description("Value is compile time constant")]
Literal = 0x0040,
[Description("Reserved (to indicate this field should not be serialized when type is remoted)")]
NotSerialized = 0x0080,
[Description("Field is special")]
SpecialName = 0x0200,
[Description("Implementation is forwarded through PInvoke.")]
PInvokeImpl = 0x2000,
[Description("CLI provides 'special' behavior, depending upon the name of the field")]
RTSpecialName = 0x0400,
[Description("Field has marshalling information")]
HasFieldMarshal = 0x1000,
[Description("Field has default")]
HasDefault = 0x8000,
[Description("Field has RVA")]
HasFieldRVA = 0x0100,
}
}
[Ecma("II.23.1.6")]
[Flags]
enum FileAttributes : uint
{
[Description("This is not a resource file")]
ContainsMetaData = 0x0000,
[Description("This is a resource file or other non-metadata-containing file")]
ContainsNoMetaData = 0x0001,
}
[Ecma("II.23.1.7")]
sealed class GenericParamAttributes : CodeNode
{
public VarianceAttributes Variance { get; private set; }
public SpecialConstraintAttributes SpecialConstraint { get; private set; }
protected override void InnerRead() {
var data = Bytes.Read<ushort>();
Variance = (VarianceAttributes)(data & varianceMask);
SpecialConstraint = (SpecialConstraintAttributes)(data & specialConstraintMask);
}
public override string NodeValue => (new Enum[] { Variance, SpecialConstraint }).GetString();
public override string Description => string.Join("\n", Variance.Describe().Concat(SpecialConstraint.Describe()));
const ushort varianceMask = 0x0003;
public enum VarianceAttributes : ushort
{
[Description("The generic parameter is non-variant and has no special constraints")]
None = 0x0000,
[Description("The generic parameter is covariant")]
Covariant = 0x0001,
[Description("The generic parameter is contravariant")]
Contravariant = 0x0002,
}
const ushort specialConstraintMask = 0x0004;
public enum SpecialConstraintAttributes : ushort
{
[Description("The generic parameter has the class special constraint")]
ReferenceTypeConstraint = 0x0004,
[Description("The generic parameter has the valuetype special constraint")]
NotNullableValueTypeConstraint = 0x0008,
[Description("The generic parameter has the .ctor special constraint")]
DefaultConstructorConstraint = 0x0010,
}
}
[Ecma("II.23.1.8")]
sealed class PInvokeAttributes : CodeNode
{
public CharacterSetAttributes CharacterSet { get; private set; }
public CallingConventionAttributes CallingConvention { get; private set; }
public AdditionalFlags Flags { get; private set; }
protected override void InnerRead() {
var data = Bytes.Read<ushort>();
CharacterSet = (CharacterSetAttributes)(data & characterSetMask);
CallingConvention = (CallingConventionAttributes)(data & callingConventionMask);
Flags = (AdditionalFlags)(data & flagsMask);
}
public override string NodeValue => (new Enum[] { CharacterSet, CallingConvention, Flags }).GetString();
public override string Description => string.Join("\n", CharacterSet.Describe()
.Concat(CallingConvention.Describe())
.Concat(Flags.Describe()));
const ushort characterSetMask = 0x0007;
public enum CharacterSetAttributes : ushort
{
[Description("")]
NotSpec = 0x0000,
[Description("")]
Ansi = 0x0002,
[Description("")]
Unicode = 0x0004,
[Description("")]
Auto = 0x0006,
}
const ushort callingConventionMask = 0x0100;
public enum CallingConventionAttributes : ushort
{
[Description("")]
PlatformAPI = 0x0100,
[Description("")]
Cdecl = 0x0200,
[Description("")]
StdCall = 0x0300,
[Description("")]
ThisCall = 0x0400,
[Description("")]
FastCall = 0x0500,
}
const ushort flagsMask = unchecked((ushort)~characterSetMask & ~callingConventionMask);
[Flags]
public enum AdditionalFlags : ushort
{
[Description("PInvoke is to use the member name as specified")]
NoMangle = 0x0001,
[Description("Information about target function. Not relevant for fields")]
SupportsLastError = 0x0040,
}
}
[Ecma("II.23.1.9")]
enum ManifestResourceAttributes : uint
{
[Description("The Resource is exported from the Assembly")]
Public = 0x0001,
[Description("The Resource is private to the Assembly")]
Private = 0x0002,
}
[Ecma("II.23.1.10")]
sealed class MethodAttributes : CodeNode
{
public MemberAccessAttributes MemberAccess { get; private set; }
public VtableLayoutAttributes VtableLayout { get; private set; }
public AdditionalFlags Flags { get; private set; }
protected override void InnerRead() {
var data = Bytes.Read<ushort>();
MemberAccess = (MemberAccessAttributes)(data & memberAccessMask);
VtableLayout = (VtableLayoutAttributes)(data & vtableLayoutMask);
Flags = (AdditionalFlags)(data & flagsMask);
}
public override string NodeValue => (new Enum[] { MemberAccess, VtableLayout, Flags }).GetString();
public override string Description => string.Join("\n", MemberAccess.Describe()
.Concat(VtableLayout.Describe())
.Concat(Flags.Describe()));
const ushort memberAccessMask = 0x0007;
public enum MemberAccessAttributes : ushort
{
[Description("Member not referenceable")]
CompilerControlled = 0x0000,
[Description("Accessible only by the parent type")]
Private = 0x0001,
[Description("Accessible by sub-types only in this Assembly")]
FamANDAssem = 0x0002,
[Description("Accessibly by anyone in the Assembly")]
Assem = 0x0003,
[Description("Accessible only by type and sub-types")]
Family = 0x0004,
[Description("Accessibly by sub-types anywhere, plus anyone in assembly")]
FamORAssem = 0x0005,
[Description("Accessibly by anyone who has visibility to this scope")]
Public = 0x0006,
}
const ushort vtableLayoutMask = 0x0100;
public enum VtableLayoutAttributes : ushort
{
[Description("Method reuses existing slot in vtable")]
ReuseSlot = 0x0000,
[Description("Method always gets a new slot in the vtable")]
NewSlot = 0x0100,
}
const ushort flagsMask = unchecked((ushort)~memberAccessMask & ~vtableLayoutMask);
[Flags]
public enum AdditionalFlags : ushort
{
[Description("Defined on type, else per instance")]
Static = 0x0010,
[Description("Method cannot be overridden")]
Final = 0x0020,
[Description("Method is virtual")]
Virtual = 0x0040,
[Description("Method hides by name+sig, else just by name")]
HideBySig = 0x0080,
[Description("Method can only be overriden if also accessible")]
Strict = 0x0200,
[Description("Method does not provide an implementation")]
Abstract = 0x0400,
[Description("Method is special")]
SpecialName = 0x0800,
[Description("Implementation is forwarded through PInvoke")]
PInvokeImpl = 0x2000,
[Description("Reserved: shall be zero for conforming implementations")]
UnmanagedExport = 0x0008,
[Description("CLI provides 'special' behavior, depending upon the name of the method")]
RTSpecialName = 0x1000,
[Description("Method has security associate with it")]
HasSecurity = 0x4000,
[Description("Method calls another method containing security code.")]
RequireSecObject = 0x8000,
}
}
[Ecma("II.23.1.11")]
sealed class MethodImplAttributes : CodeNode
{
public CodeTypeAttributes CodeType { get; private set; }
public ManagedAttributes Managed { get; private set; }
public AdditionalFlags Flags { get; private set; }
protected override void InnerRead() {
var data = Bytes.Read<ushort>();
CodeType = (CodeTypeAttributes)(data & codeTypeMask);
Managed = (ManagedAttributes)(data & managedMask);
Flags = (AdditionalFlags)(data & flagsMask);
}
public override string NodeValue => (new Enum[] { CodeType, Managed, Flags }).GetString();
public override string Description => string.Join("\n", CodeType.Describe()
.Concat(Managed.Describe())
.Concat(Flags.Describe()));
const ushort codeTypeMask = 0x0003;
public enum CodeTypeAttributes : ushort
{
[Description("Method impl is CIL")]
IL = 0x0000,
[Description("Method impl is native")]
Native = 0x0001,
[Description("Reserved: shall be zero in conforming implementations")]
OPTIL = 0x0002,
[Description("Method impl is provided by the runtime")]
Runtime = 0x0003,
}
const ushort managedMask = 0x0004;
public enum ManagedAttributes : ushort
{
[Description("Method impl is unmanaged")]
Unmanaged = 0x0004,
[Description("Method impl is managed")]
Managed = 0x0000,
}
const ushort flagsMask = unchecked((ushort)~codeTypeMask & ~managedMask);
[Flags]
public enum AdditionalFlags : ushort
{
[Description("Method cannot be inlined")]
NoInlining = 0x0008,
[Description("Indicates method is defined; used primarily in merge scenarios")]
ForwardRef = 0x0010,
[Description("Method is single threaded through the body")]
Synchronized = 0x0020,
[Description("Method will not be optimized when generating native code")]
NoOptimization = 0x0040,
[Description("Reserved: conforming implementations can ignore")]
PreserveSig = 0x0080,
[Description("Reserved: shall be zero in conforming implementations")]
InternalCall = 0x1000,
}
}
[Ecma("II.23.1.12")]
[Flags]
enum MethodSemanticsAttributes : ushort
{
[Description("Setter for property")]
Setter = 0x0001,
[Description("Getter for property")]
Getter = 0x0002,
[Description("Other method for property or event")]
Other = 0x0004,
[Description("AddOn method for event. This refers to the required add_ method for events.")] // Typo in spec! Description had text "(§22.13)" but should be II.22.13
//MAYBE enum value codenode already links to II.23.1.12 so can't also link to II.22
AddOn = 0x0008,
[Description("RemoveOn method for event. This refers to the required remove_ method for events.")]
RemoveOn = 0x0010,
[Description("Fire method for event. This refers to the optional raise_ method for events.")]
Fire = 0x0020,
}
[Ecma("II.23.1.13")]
[Flags]
public enum ParamAttributes : ushort
{
[Description("Param is [In]")]
In = 0x0001,
[Description("Param is [out]")]
Out = 0x0002,
[Description("Param is optional")]
Optional = 0x0010,
[Description("Param has default value")]
HasDefault = 0x1000,
[Description("Param has FieldMarshal")]
HasFieldMarshal = 0x2000,
}
[Ecma("II.23.1.14")]
[Flags]
enum PropertyAttributes : ushort
{
[Description("Property is special")]
SpecialName = 0x0200,
[Description("Runtime(metadata internal APIs) should check name encoding")]
RTSpecialName = 0x0400,
[Description("Property has default")]
HasDefault = 0x1000,
}
[Ecma("II.23.1.15")]
sealed class TypeAttributes : CodeNode
{
public uint Data;
public VisibilityAttributes Visibility { get; private set; }
public LayoutAttributes Layout { get; private set; }
public ClassSemanticsAttributes ClassSemantics { get; private set; }
public StringInteropFormatAttributes StringInteropFormat { get; private set; }
public AdditionalFlags Flags { get; private set; }
protected override void InnerRead() {
var data = Bytes.Read<uint>();
Visibility = (VisibilityAttributes)(data & visibilityMask);
Layout = (LayoutAttributes)(data & layoutMask);
ClassSemantics = (ClassSemanticsAttributes)(data & classSemanticsMask);
StringInteropFormat = (StringInteropFormatAttributes)(data & stringInteropFormatMask);
Flags = (AdditionalFlags)(data & flagsMask);
}
public override string NodeValue => (new Enum[] { Visibility, Layout, ClassSemantics, StringInteropFormat, Flags }).GetString();
public override string Description => string.Join("\n", Visibility.Describe()
.Concat(Layout.Describe())
.Concat(ClassSemantics.Describe())
.Concat(StringInteropFormat.Describe())
.Concat(Flags.Describe()));
const uint visibilityMask = 0x00000007;
public enum VisibilityAttributes : uint
{
[Description("Class has no public scope")]
NotPublic = 0x00000000,
[Description("Class has public scope")]
Public = 0x00000001,
[Description("Class is nested with public visibility")]
NestedPublic = 0x00000002,
[Description("Class is nested with private visibility")]
NestedPrivate = 0x00000003,
[Description("Class is nested with family visibility")]
NestedFamily = 0x00000004,
[Description("Class is nested with assembly visibility")]
NestedAssembly = 0x00000005,
[Description("Class is nested with family and assembly visibility")]
NestedFamANDAssem = 0x00000006,
[Description("Class is nested with family or assembly visibility")]
NestedFamORAssem = 0x00000007,
}
const uint layoutMask = 0x00000018;
public enum LayoutAttributes : uint
{
[Description("Class fields are auto-laid out")]
AutoLayout = 0x00000000,
[Description("Class fields are laid out sequentially")]
SequentialLayout = 0x00000008,
[Description("Layout is supplied explicitly")]
ExplicitLayout = 0x00000010,
}
const uint classSemanticsMask = 0x00000020;
public enum ClassSemanticsAttributes : uint
{
[Description("Type is a class")]
Class = 0x00000000,
[Description("Type is an interface")]
Interface = 0x00000020,
}
const uint stringInteropFormatMask = 0x00030000;
public enum StringInteropFormatAttributes : uint
{
[Description("LPSTR is interpreted as ANSI")]
AnsiClass = 0x00000000,
[Description("LPSTR is interpreted as Unicode")]
UnicodeClass = 0x00010000,
[Description("LPSTR is interpreted automatically")]
AutoClass = 0x00020000,
[Description("A non-standard encoding specified by CustomStringFormatMask, look at bits masked by 0x00C00000 for meaning, unspecified")]
CustomFormatClass = 0x00030000,
}
const uint flagsMask = ~visibilityMask & ~layoutMask & ~classSemanticsMask & ~stringInteropFormatMask;
[Flags]
public enum AdditionalFlags : uint
{
[Description("Class is abstract")]
Abstract = 0x00000080,
[Description("Class cannot be extended")]
Sealed = 0x00000100,
[Description("Class name is special")]
SpecialName = 0x00000400,
[Description("Class/Interface is imported")]
Import = 0x00001000,
[Description("Reserved (Class is serializable)")]
Serializable = 0x00002000,
[Description("Initialize the class before first static field access")]
BeforeFieldInit = 0x00100000,
[Description("CLI provides 'special' behavior, depending upon the name of the Type")]
RTSpecialName = 0x00000800,
[Description("Type has security associate with it")]
HasSecurity = 0x00040000,
[Description("This ExportedType entry is a type forwarder")]
IsTypeForwarder = 0x00200000,
}
}
[Ecma("II.23.1.16")]
enum ElementType : byte
{
[Description("Marks end of a list")]
End = 0x00,
[Description("void")]
Void = 0x01,
[Description("bool")]
Boolean = 0x02,
[Description("char")]
Char = 0x03,
[Description("sbyte")]
Int1 = 0x04,
[Description("byte")]
UInt1 = 0x05,
[Description("short")]
Int2 = 0x06,
[Description("ushort")]
UInt2 = 0x07,
[Description("int")]
Int4 = 0x08,
[Description("uint")]
UInt4 = 0x09,
[Description("long")]
Int8 = 0x0a,
[Description("ulong")]
UInt8 = 0x0b,
[Description("float")]
Real4 = 0x0c,
[Description("double")]
Real8 = 0x0d,
[Description("string")]
String = 0x0e,
[Description("Followed by type")]
Ptr = 0x0f,
[Description("Followed by type")]
ByRef = 0x10,
[Description("Followed by TypeDef or TypeRef token")]
ValueType = 0x11,
[Description("Followed by TypeDef or TypeRef token")]
Class = 0x12,
[Description("Generic parameter in a generic type definition, represented as number (compressed unsigned integer)")]
Var = 0x13,
[Description("type rank boundsCount bound1 ... loCount lo1 ...")]
Array = 0x14,
[Description("Generic type instantiation. Followed by type type-arg-count type-1 ... type-n")]
GenericInst = 0x15,
[Description("System.TypedReference")]
TypedByRef = 0x16,
[Description("System.IntPtr")]
IntPtr = 0x18,
[Description("System.UIntPtr")]
UIntPtr = 0x19,
[Description("Followed by full method signature")]
Fnptr = 0x1b,
[Description("System.Object")]
Object = 0x1c,
[Description("Single-dim array with 0 lower bound")]
SzArray = 0x1d,
[Description("Generic parameter in a generic method definition, represented as number (compressed unsigned integer)")]
MVar = 0x1e,
[Description("Required modifier : followed by a TypeDef or TypeRef token")]
CModReqd = 0x1f,
[Description("Optional modifier : followed by a TypeDef or TypeRef token")]
CModOpt = 0x20,
[Description("Implemented within the CLI")]
Internal = 0x21,
[Description("Or'd with following element types")]
Modifier = 0x40,
[Description("Sentinel for vararg method signature")]
Sentinel = 0x41,
[Description("Denotes a local variable that points at a pinned object")]
Pinned = 0x45,
[Description("Indicates an argument of type System.Type.")]
Unknown1 = 0x50,
[Description("Used in custom attributes to specify a boxed object (§II.23.3).")]
Unknown2 = 0x51,
[Description("Reserved")]
Unknown3 = 0x52,
[Description("Used in custom attributes to indicate a FIELD (§II.22.10, II.23.3).")]
Unknown4 = 0x53,
//TODO(fixme) 0x54 and 0x55 for custom attributes
}
static class ElementTypeExtensions
{
// Print enum values the way you'd expect in C#
public static string S(this ElementType type) => type switch {
// ElementType.End => "",
ElementType.Void => "void",
ElementType.Boolean => "bool",
ElementType.Char => "char",
ElementType.Int1 => "sbyte",
ElementType.UInt1 => "byte",
ElementType.Int2 => "short",
ElementType.UInt2 => "ushort",
ElementType.Int4 => "int",
ElementType.UInt4 => "uint",
ElementType.Int8 => "long",
ElementType.UInt8 => "ulong",
ElementType.Real4 => "float",
ElementType.Real8 => "double",
ElementType.String => "string",
// ElementType.Ptr => "",
// ElementType.ByRef => "",
ElementType.ValueType => "valuetype",
ElementType.Class => "class",
// ElementType.Var => "",
// ElementType.Array => "",
// ElementType.GenericInst => "",
ElementType.TypedByRef => "typedref",
ElementType.IntPtr => "IntPtr",
ElementType.UIntPtr => "UIntPtr",
// ElementType.Fnptr => "",
ElementType.Object => "object",
// ElementType.SzArray => "",
// ElementType.MVar => "",
// ElementType.CModReqd => "",
// ElementType.CModOpt => "",
// ElementType.Internal => "",
// ElementType.Modifier => "",
// ElementType.Sentinel => "",
ElementType.Pinned => "pinned",
// ElementType.Unknown1 => "",
// ElementType.Unknown2 => "",
// ElementType.Unknown3 => "",
// ElementType.Unknown4 => "",
_ => type.ToString(),
};
}
// MAYBE split to a new file https://devblogs.microsoft.com/oldnewthing/20190916-00/?p=102892
[Ecma("II.24.2.1")]
sealed class MetadataRoot : CodeNode
{
[Description("Magic signature for physical metadata : 0x424A5342.")]
public uint Signature;
[Description("Major version, 1 (ignore on read)")]
[Expected(1)]
public ushort MajorVersion;
[Description("Minor version, 1 (ignore on read)")]
[Expected(1)]
public ushort MinorVersion;
[Description("Reserved, always 0.")]
public uint Reserved;
[Description("Number of bytes allocated to hold version string, rounded up to a multiple of four.")]
public uint Length;
[Description("UTF8-encoded null-terminated version string.")]
public NullTerminatedString Version = new NullTerminatedString(Encoding.UTF8, 4);
[Description("Reserved, always 0.")]
[Expected(0)]
public ushort Flags;
[Description("Number of streams.")]
public ushort Streams;
[OrderedField]
public StreamHeader[] StreamHeaders;
protected override int GetCount(string field) => field switch {
nameof(StreamHeaders) => Streams,
_ => base.GetCount(field),
};
}
[Ecma("II.24.2.2")]
sealed class StreamHeader : CodeNode
{
[Description("Memory offset to start of this stream from start of the metadata root")]
[Ecma("II.24.2.1")]
public uint Offset;
[Description("Size of this stream in bytes, shall be a multiple of 4.")]
public uint Size; //TODO(size)
[Description("Name of the stream as null-terminated variable length array of ASCII characters, padded to the next 4 - byte boundary with null characters.")]
public NullTerminatedString Name = new NullTerminatedString(Encoding.ASCII, 4);
}
abstract class Heap<T> : CodeNode
{
int size;
SortedList<int, (T, CodeNode)> children = new SortedList<int, (T, CodeNode)>();
public Heap(int size) {
this.size = size;
}
protected override void InnerRead() {
// Parsing the data now isn't possible
Bytes.Stream.Position += size;
}
protected abstract (T, CodeNode) ReadChild(int index);
protected (T t, CodeNode node) AddChild(int index) {
using (Bytes.TempReposition(Start + index)) {
if (!children.TryGetValue(index, out var childpair)) {
var (t, child) = ReadChild(index);
if (child == null) {
return (t, this);
}
child.NodeName = $"{GetType().Name}[{index}]";
childpair = (t, child);
children.Add(index, childpair);
Children.Add(child);
AdjustChildRanges(index, child);
}
return childpair;
}
}
//TODO(pedant) Binary heaps members are allowed to overlap to save space, allow for this in javascript
void AdjustChildRanges(int index, CodeNode child) {
var chI = children.IndexOfKey(index);
if (chI != 0) {
AdjustChildren(children.Values[chI - 1].Item2, child);
}
if (chI + 1 != children.Count) {
AdjustChildren(child, children.Values[chI + 1].Item2);
}
}
static void AdjustChildren(CodeNode before, CodeNode after) {
if (before.End > after.Start) {
before.Description = @"(Sharing bytes with the next element...)";
before.End = after.Start;
}
}
public T Get(int i) => AddChild(i).t;
public CodeNode GetNode(int i) => AddChild(i).node;
public sealed class EncodedLength : CodeNode
{
public int length;
public override string NodeValue => length.ToString();
protected override void InnerRead() {
var first = Bytes.Read<byte>();
if ((first & 0b1000_0000) == 0) {
length = first & 0x7F;
Description = "Starts with bit pattern 0 so Length is 1 byte";
} else if ((first & 0b1100_0000) == 0b1000_0000) {
var second = Bytes.Read<byte>();
length = ((first & 0x3F) << 8) + second;
Description = "Starts with bit pattern 10 so Length is 2 bytes";
} else if ((first & 0b1110_0000) == 0b1100_0000) {
var second = Bytes.Read<byte>();
var third = Bytes.Read<byte>();
var fourth = Bytes.Read<byte>();
length = ((first & 0x1F) << 24) + (second << 16) + (third << 8) + fourth;
Description = "Starts with bit pattern 110 so Length is 4 bytes";
} else {
throw new InvalidOperationException($"Heap byte {Bytes.Stream.Position - 1:X} can't start with bits 1111...");
}
}
}
}
[Ecma("II.24.2.3")]
sealed class StringHeap : Heap<string>
{
public StringHeap(int size)
: base(size) {
}
protected override (string, CodeNode) ReadChild(int index) {
var s = new NullTerminatedString(Encoding.UTF8, 1) { Bytes = Bytes };
s.Read();
return (s.Str, s);
}
}
[Ecma("II.24.2.4")]
sealed class UserStringHeap : Heap<string>
{
public UserStringHeap(int size)
: base(size) {
}
protected override (string, CodeNode) ReadChild(int index) {
var entry = Bytes.ReadClass<Entry>();
return (entry.String.Str, entry);
}
[Ecma("II.24.2.4")]
sealed class Entry : CodeNode
{
public EncodedLength Length;
public FixedLengthString String;
public override string NodeValue => String.NodeValue;
protected override void InnerRead() {
AddChild(nameof(Length));
String = new FixedLengthString(Length.length);
AddChild(nameof(String));
}
}
sealed class FixedLengthString : CodeNode // MAYBE refactor all to record types
{
public string Str { get; private set; } = "oops unset!!";
int length;
public FixedLengthString(int length) {
this.length = length;
}
protected override void InnerRead() {
var arr = new byte[length - 1]; // skip terminal byte
if (!Bytes.Stream.TryReadWholeArray(arr, out var error)) {
Errors.Add(error);
return;
}
Str = Encoding.Unicode.GetString(arr);
NodeValue = Str.GetString();
}
}
}
[Ecma("II.24.2.4")]
sealed class BlobHeap : Heap<object>
{
public BlobHeap(int size)
: base(size) {
}
CodeNode customEntry; // hack so GetCustom() can pass type info into ReadChild()
protected override (object, CodeNode) ReadChild(int index) {
if (customEntry != null) {
var custom = customEntry;
customEntry = null; // set null immediately so renentrant GetCustom calls don't see customEntry
custom.Read();
var ret = (((IEntry)custom).IValue, custom);
return ret;
}
var entry = Bytes.ReadClass<BytesEntry>();
if (entry.Blob.arr.Length == 0) {
entry.Description = "Empty blob";
entry.Children.Clear();
}
return (entry.Blob.arr, entry);
}
public byte GetByte(int index) {
using (Bytes.TempReposition(Start + index)) {
Bytes.ReadClass<EncodedLength>();
return Bytes.Read<byte>();
}
}
public T GetCustom<T>(int i) where T : CodeNode, new() {
if (customEntry != null) throw new InvalidOperationException();
customEntry = new CustomEntry<T> { Bytes = Bytes };
var o = AddChild(i);
if (customEntry != null) {
if (o.t is T) {
customEntry = null; // Reading the same bytes as the same type again should be idempotent
} else {
throw new NotImplementedException("Custom read of data overlaps with another type");
}
}
return (T)o.t;
}
[Ecma("II.24.2.4")]
sealed class BytesEntry : CodeNode
{
public EncodedLength Length;
public ByteArrayNode Blob;
public override string NodeValue => Blob.NodeValue;
protected override void InnerRead() {
AddChild(nameof(Length));
Blob = new ByteArrayNode(Length.length);
AddChild(nameof(Blob));
}
}
[Ecma("II.24.2.4")]
sealed class CustomEntry<T> : CodeNode, IEntry where T : CodeNode, new()
{
public EncodedLength Length;
public T Value;
public object IValue => Value;
public override string NodeValue => Value.NodeValue;
protected override void InnerRead() {
AddChild(nameof(Length));
AddChild(nameof(Value));
if (Value.End != Value.Start + Length.length) {
Errors.Add($"Custom data {typeof(T).Name} isn't size of entire blob");
}
Children.Last().NodeName = typeof(T).Name;
}
}
interface IEntry
{
object IValue { get; }
}
public sealed class ByteArrayNode : CodeNode
{
public byte[] arr;
public ByteArrayNode(int length) {
arr = new byte[length];
}
protected override void InnerRead() {
Bytes.Stream.ReadWholeArray(arr);
NodeValue = arr.GetString();
}
}
}
[Ecma("II.24.2.5")]
sealed class GuidHeap : Heap<Guid>
{
public GuidHeap(int size)
: base(size) {
}
protected override (Guid, CodeNode) ReadChild(int index) {
if (index == 0) return (Guid.Empty, null);
Bytes.Stream.Position -= index; // Undo ReadChild offset
const int size = 16;
Bytes.Stream.Position += (index - 1) * size; // GuidHeap is indexed from 1
var g = Bytes.ReadClass<StructNode<Guid>>();
return (g.t, g);
}
}
[Ecma("II.24.2.6")]
sealed class TildeStreamRows : CodeNode
{
int count;
public TildeStreamRows(int count) {
this.count = count;
}
//TODO(Descriptions) give a name for each row. Using StructNode<uint> keeps each row its own size
[Ecma("II.24.2.6")]
public StructNode<uint>[] Rows; //TODO(size)
protected override int GetCount(string field) => count;
}
[Ecma("II.24.2.6")]
sealed class TildeStream : CodeNode
{
public Section Section { get; private set; }
public TildeStream(Section section) {
Section = section;
}
public TildeData TildeData;
public TildeStreamRows Rows;
// MAYBE validate the sorted order based on primary/secondary key in II.22
public Module[] Modules;