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
|
//
// mono-api-info.cs - Dumps public assembly information to an xml file.
//
// Authors:
// Gonzalo Paniagua Javier (gonzalo@ximian.com)
//
// Copyright (C) 2003-2008 Novell, Inc (http://www.novell.com)
//
using System;
using System.Collections;
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Runtime.CompilerServices;
using System.Runtime.InteropServices;
using System.Security.Permissions;
using System.Text;
using System.Xml;
using Mono.Cecil;
using Mono.Cecil.Cil;
using System.IO;
namespace CorCompare
{
public class Driver
{
public static int Main (string [] args)
{
bool showHelp = false;
AbiMode = false;
FollowForwarders = false;
string output = null;
var acoll = new AssemblyCollection ();
var options = new Mono.Options.OptionSet {
"usage: mono-api-info [OPTIONS+] ASSEMBLY+",
"",
"Expose IL structure of CLR assemblies as XML.",
"",
"Available Options:",
{ "abi",
"Generate ABI, not API; contains only classes with instance fields which are not [NonSerialized].",
v => AbiMode = v != null },
{ "f|follow-forwarders",
"Follow type forwarders.",
v => FollowForwarders = v != null },
{ "d|L|lib|search-directory=",
"Check for assembly references in {DIRECTORY}.",
v => TypeHelper.Resolver.AddSearchDirectory (v) },
{ "r=",
"Read and register the file {ASSEMBLY}, and add the directory containing ASSEMBLY to the search path.",
v => TypeHelper.Resolver.ResolveFile (v) },
{ "o=",
"The output file. If not specified the output will be written to stdout.",
v => output = v },
{ "h|?|help",
"Show this message and exit.",
v => showHelp = v != null },
};
var asms = options.Parse (args);
if (showHelp || asms.Count == 0) {
options.WriteOptionDescriptions (Console.Out);
Console.WriteLine ();
return showHelp? 0 :1;
}
string windir = Environment.GetFolderPath(Environment.SpecialFolder.Windows);
string pf = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"assembly\GAC\MSDATASRC\7.0.3300.0__b03f5f7f11d50a3a"));
foreach (string arg in asms) {
acoll.Add (arg);
if (arg.Contains ("v3.0")) {
TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v2.0.50727"));
} else if (arg.Contains ("v3.5")) {
TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v2.0.50727"));
TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v3.0\Windows Communication Foundation"));
} else if (arg.Contains ("v4.0")) {
if (arg.Contains ("Silverlight")) {
TypeHelper.Resolver.AddSearchDirectory (Path.Combine (pf, @"Microsoft Silverlight\4.0.51204.0"));
} else {
TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v4.0.30319"));
TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v4.0.30319\WPF"));
}
} else {
TypeHelper.Resolver.AddSearchDirectory (Path.GetDirectoryName (arg));
}
}
XmlDocument doc = new XmlDocument ();
acoll.Document = doc;
acoll.DoOutput ();
TextWriter outputStream = null;
if (!string.IsNullOrEmpty (output))
outputStream = new StreamWriter (output);
try {
var writer = new WellFormedXmlWriter (new XmlTextWriter (outputStream ?? Console.Out) { Formatting = Formatting.Indented });
XmlNode decl = doc.CreateXmlDeclaration ("1.0", "utf-8", null);
doc.InsertBefore (decl, doc.DocumentElement);
doc.WriteTo (writer);
} finally {
if (outputStream != null)
outputStream.Dispose ();
}
return 0;
}
internal static bool AbiMode { get; private set; }
internal static bool FollowForwarders { get; private set; }
}
public class Utils {
public static string CleanupTypeName (TypeReference type)
{
return CleanupTypeName (type.FullName);
}
public static string CleanupTypeName (string t)
{
return t.Replace ('<', '[').Replace ('>', ']').Replace ('/', '+');
}
}
class AssemblyCollection
{
XmlDocument document;
List<AssemblyDefinition> assemblies = new List<AssemblyDefinition> ();
public AssemblyCollection ()
{
}
public bool Add (string name)
{
AssemblyDefinition ass = LoadAssembly (name);
if (ass == null) {
Console.Error.WriteLine ("Cannot load assembly file " + name);
return false;
}
assemblies.Add (ass);
return true;
}
public void DoOutput ()
{
if (document == null)
throw new InvalidOperationException ("Document not set");
XmlNode nassemblies = document.CreateElement ("assemblies", null);
document.AppendChild (nassemblies);
foreach (AssemblyDefinition a in assemblies) {
AssemblyData data = new AssemblyData (document, nassemblies, a);
data.DoOutput ();
}
}
public XmlDocument Document {
set { document = value; }
}
AssemblyDefinition LoadAssembly (string assembly)
{
try {
if (File.Exists (assembly))
return TypeHelper.Resolver.ResolveFile (assembly);
return TypeHelper.Resolver.Resolve (assembly);
} catch (Exception e) {
Console.WriteLine (e);
return null;
}
}
}
abstract class BaseData
{
protected XmlDocument document;
protected XmlNode parent;
protected BaseData (XmlDocument doc, XmlNode parent)
{
this.document = doc;
this.parent = parent;
}
public abstract void DoOutput ();
protected void AddAttribute (XmlNode node, string name, string value)
{
XmlAttribute attr = document.CreateAttribute (name);
attr.Value = value;
node.Attributes.Append (attr);
}
}
class TypeForwardedToData : BaseData
{
AssemblyDefinition ass;
public TypeForwardedToData (XmlDocument document, XmlNode parent, AssemblyDefinition ass)
: base (document, parent)
{
this.ass = ass;
}
public override void DoOutput ()
{
XmlNode natts = parent.SelectSingleNode("attributes");
if (natts == null) {
natts = document.CreateElement ("attributes", null);
parent.AppendChild (natts);
}
foreach (ExportedType type in ass.MainModule.ExportedTypes) {
if (((uint)type.Attributes & 0x200000u) == 0)
continue;
XmlNode node = document.CreateElement ("attribute");
AddAttribute (node, "name", typeof (TypeForwardedToAttribute).FullName);
XmlNode properties = node.AppendChild (document.CreateElement ("properties"));
XmlNode property = properties.AppendChild (document.CreateElement ("property"));
AddAttribute (property, "name", "Destination");
AddAttribute (property, "value", Utils.CleanupTypeName (type.FullName));
natts.AppendChild (node);
}
}
public static void OutputForwarders (XmlDocument document, XmlNode parent, AssemblyDefinition ass)
{
TypeForwardedToData tftd = new TypeForwardedToData (document, parent, ass);
tftd.DoOutput ();
}
}
class AssemblyData : BaseData
{
AssemblyDefinition ass;
public AssemblyData (XmlDocument document, XmlNode parent, AssemblyDefinition ass)
: base (document, parent)
{
this.ass = ass;
}
public override void DoOutput ()
{
if (document == null)
throw new InvalidOperationException ("Document not set");
XmlNode nassembly = document.CreateElement ("assembly", null);
AssemblyNameDefinition aname = ass.Name;
AddAttribute (nassembly, "name", aname.Name);
AddAttribute (nassembly, "version", aname.Version.ToString ());
parent.AppendChild (nassembly);
if (!Driver.FollowForwarders) {
TypeForwardedToData.OutputForwarders (document, nassembly, ass);
}
AttributeData.OutputAttributes (document, nassembly, ass);
var types = new List<TypeDefinition> ();
if (ass.MainModule.Types != null) {
types.AddRange (ass.MainModule.Types);
}
if (Driver.FollowForwarders && ass.MainModule.ExportedTypes != null) {
foreach (var t in ass.MainModule.ExportedTypes) {
var forwarded = t.Resolve ();
if (forwarded == null) {
throw new Exception ("Could not resolve forwarded type " + t.FullName + " in " + ass.Name);
}
types.Add (forwarded);
}
}
if (types.Count == 0) {
return;
}
types.Sort (TypeReferenceComparer.Default);
XmlNode nss = document.CreateElement ("namespaces", null);
nassembly.AppendChild (nss);
string current_namespace = "$%&$&";
XmlNode ns = null;
XmlNode classes = null;
foreach (TypeDefinition t in types) {
if (string.IsNullOrEmpty (t.Namespace))
continue;
if (!Driver.AbiMode && ((t.Attributes & TypeAttributes.VisibilityMask) != TypeAttributes.Public))
continue;
if (t.DeclaringType != null)
continue; // enforce !nested
if (t.Namespace != current_namespace) {
current_namespace = t.Namespace;
ns = document.CreateElement ("namespace", null);
AddAttribute (ns, "name", current_namespace);
nss.AppendChild (ns);
classes = document.CreateElement ("classes", null);
ns.AppendChild (classes);
}
TypeData bd = new TypeData (document, classes, t);
bd.DoOutput ();
}
}
}
abstract class MemberData : BaseData
{
MemberReference [] members;
public MemberData (XmlDocument document, XmlNode parent, MemberReference [] members)
: base (document, parent)
{
this.members = members;
}
public override void DoOutput ()
{
XmlNode mclass = document.CreateElement (ParentTag, null);
parent.AppendChild (mclass);
foreach (MemberReference member in members) {
XmlNode mnode = document.CreateElement (Tag, null);
mclass.AppendChild (mnode);
AddAttribute (mnode, "name", GetName (member));
if (!NoMemberAttributes)
AddAttribute (mnode, "attrib", GetMemberAttributes (member));
AttributeData.OutputAttributes (document, mnode, (ICustomAttributeProvider) member);
AddExtraData (mnode, member);
}
}
protected virtual void AddExtraData (XmlNode p, MemberReference memberDefenition)
{
}
protected virtual string GetName (MemberReference memberDefenition)
{
return "NoNAME";
}
protected virtual string GetMemberAttributes (MemberReference memberDefenition)
{
return null;
}
public virtual bool NoMemberAttributes {
get { return false; }
set {}
}
public virtual string ParentTag {
get { return "NoPARENTTAG"; }
}
public virtual string Tag {
get { return "NoTAG"; }
}
public static void OutputGenericParameters (XmlDocument document, XmlNode nclass, IGenericParameterProvider provider)
{
if (provider.GenericParameters.Count == 0)
return;
var gparameters = provider.GenericParameters;
XmlElement ngeneric = document.CreateElement ("generic-parameters");
nclass.AppendChild (ngeneric);
foreach (GenericParameter gp in gparameters) {
XmlElement nparam = document.CreateElement ("generic-parameter");
nparam.SetAttribute ("name", gp.Name);
nparam.SetAttribute ("attributes", ((int) gp.Attributes).ToString ());
AttributeData.OutputAttributes (document, nparam, gp);
ngeneric.AppendChild (nparam);
var constraints = gp.Constraints;
if (constraints.Count == 0)
continue;
XmlElement nconstraint = document.CreateElement ("generic-parameter-constraints");
foreach (TypeReference constraint in constraints) {
XmlElement ncons = document.CreateElement ("generic-parameter-constraint");
ncons.SetAttribute ("name", Utils.CleanupTypeName (constraint));
nconstraint.AppendChild (ncons);
}
nparam.AppendChild (nconstraint);
}
}
}
class TypeData : MemberData
{
TypeDefinition type;
public TypeData (XmlDocument document, XmlNode parent, TypeDefinition type)
: base (document, parent, null)
{
this.type = type;
}
public override void DoOutput ()
{
if (document == null)
throw new InvalidOperationException ("Document not set");
XmlNode nclass = document.CreateElement ("class", null);
AddAttribute (nclass, "name", type.Name);
string classType = GetClassType (type);
AddAttribute (nclass, "type", classType);
if (type.BaseType != null)
AddAttribute (nclass, "base", Utils.CleanupTypeName (type.BaseType));
if (type.IsSealed)
AddAttribute (nclass, "sealed", "true");
if (type.IsAbstract)
AddAttribute (nclass, "abstract", "true");
if ( (type.Attributes & TypeAttributes.Serializable) != 0 || type.IsEnum)
AddAttribute (nclass, "serializable", "true");
string charSet = GetCharSet (type);
AddAttribute (nclass, "charset", charSet);
string layout = GetLayout (type);
if (layout != null)
AddAttribute (nclass, "layout", layout);
if (type.PackingSize >= 0) {
AddAttribute (nclass, "pack", type.PackingSize.ToString ());
}
if (type.ClassSize >= 0) {
AddAttribute (nclass, "size", type.ClassSize.ToString ());
}
parent.AppendChild (nclass);
AttributeData.OutputAttributes (document, nclass, type);
XmlNode ifaces = null;
foreach (TypeReference iface in TypeHelper.GetInterfaces (type).OrderBy (s => s.FullName)) {
if (!TypeHelper.IsPublic (iface))
// we're only interested in public interfaces
continue;
if (ifaces == null) {
ifaces = document.CreateElement ("interfaces", null);
nclass.AppendChild (ifaces);
}
XmlNode iface_node = document.CreateElement ("interface", null);
AddAttribute (iface_node, "name", Utils.CleanupTypeName (iface));
ifaces.AppendChild (iface_node);
}
MemberData.OutputGenericParameters (document, nclass, type);
ArrayList members = new ArrayList ();
FieldDefinition [] fields = GetFields (type);
if (fields.Length > 0) {
Array.Sort (fields, MemberReferenceComparer.Default);
FieldData fd = new FieldData (document, nclass, fields);
members.Add (fd);
}
if (type.IsEnum) {
var value_type = GetEnumValueField (type);
if (value_type == null)
throw new NotSupportedException ();
AddAttribute (nclass, "enumtype", Utils.CleanupTypeName (value_type.FieldType));
}
if (!Driver.AbiMode) {
MethodDefinition [] ctors = GetConstructors (type);
if (ctors.Length > 0) {
Array.Sort (ctors, MethodDefinitionComparer.Default);
members.Add (new ConstructorData (document, nclass, ctors));
}
PropertyDefinition[] properties = GetProperties (type);
if (properties.Length > 0) {
Array.Sort (properties, PropertyDefinitionComparer.Default);
members.Add (new PropertyData (document, nclass, properties));
}
EventDefinition [] events = GetEvents (type);
if (events.Length > 0) {
Array.Sort (events, MemberReferenceComparer.Default);
members.Add (new EventData (document, nclass, events));
}
MethodDefinition [] methods = GetMethods (type);
if (methods.Length > 0) {
Array.Sort (methods, MethodDefinitionComparer.Default);
members.Add (new MethodData (document, nclass, methods));
}
}
foreach (MemberData md in members)
md.DoOutput ();
var nested = type.NestedTypes;
//remove non public(familiy) and nested in second degree
for (int i = nested.Count - 1; i >= 0; i--) {
TypeDefinition t = nested [i];
if ((t.Attributes & TypeAttributes.VisibilityMask) == TypeAttributes.NestedPublic ||
(t.Attributes & TypeAttributes.VisibilityMask) == TypeAttributes.NestedFamily ||
(t.Attributes & TypeAttributes.VisibilityMask) == TypeAttributes.NestedFamORAssem) {
// public
if (t.DeclaringType == type)
continue; // not nested of nested
}
nested.RemoveAt (i);
}
if (nested.Count > 0) {
var nestedArray = nested.ToArray ();
Array.Sort (nestedArray, TypeReferenceComparer.Default);
XmlNode classes = document.CreateElement ("classes", null);
nclass.AppendChild (classes);
foreach (TypeDefinition t in nestedArray) {
TypeData td = new TypeData (document, classes, t);
td.DoOutput ();
}
}
}
static FieldReference GetEnumValueField (TypeDefinition type)
{
foreach (FieldDefinition field in type.Fields)
if (field.IsSpecialName && field.Name == "value__")
return field;
return null;
}
protected override string GetMemberAttributes (MemberReference member)
{
if (member != type)
throw new InvalidOperationException ("odd");
return ((int) type.Attributes).ToString (CultureInfo.InvariantCulture);
}
public static bool MustDocumentMethod (MethodDefinition method) {
// All other methods
MethodAttributes maskedAccess = method.Attributes & MethodAttributes.MemberAccessMask;
return maskedAccess == MethodAttributes.Public
|| maskedAccess == MethodAttributes.Family
|| maskedAccess == MethodAttributes.FamORAssem;
}
static string GetClassType (TypeDefinition t)
{
if (t.IsEnum)
return "enum";
if (t.IsValueType)
return "struct";
if (t.IsInterface)
return "interface";
if (TypeHelper.IsDelegate(t))
return "delegate";
if (t.IsPointer)
return "pointer";
return "class";
}
static string GetCharSet (TypeDefinition type)
{
TypeAttributes maskedStringFormat = type.Attributes & TypeAttributes.StringFormatMask;
if (maskedStringFormat == TypeAttributes.AnsiClass)
return CharSet.Ansi.ToString ();
if (maskedStringFormat == TypeAttributes.AutoClass)
return CharSet.Auto.ToString ();
if (maskedStringFormat == TypeAttributes.UnicodeClass)
return CharSet.Unicode.ToString ();
return CharSet.None.ToString ();
}
static string GetLayout (TypeDefinition type)
{
TypeAttributes maskedLayout = type.Attributes & TypeAttributes.LayoutMask;
if (maskedLayout == TypeAttributes.AutoLayout)
return LayoutKind.Auto.ToString ();
if (maskedLayout == TypeAttributes.ExplicitLayout)
return LayoutKind.Explicit.ToString ();
if (maskedLayout == TypeAttributes.SequentialLayout)
return LayoutKind.Sequential.ToString ();
return null;
}
FieldDefinition [] GetFields (TypeDefinition type) {
ArrayList list = new ArrayList ();
var fields = type.Fields;
foreach (FieldDefinition field in fields) {
if (field.IsSpecialName)
continue;
if (Driver.AbiMode && field.IsStatic)
continue;
// we're only interested in public or protected members
FieldAttributes maskedVisibility = (field.Attributes & FieldAttributes.FieldAccessMask);
if (Driver.AbiMode && !field.IsNotSerialized) {
list.Add (field);
} else {
if (maskedVisibility == FieldAttributes.Public
|| maskedVisibility == FieldAttributes.Family
|| maskedVisibility == FieldAttributes.FamORAssem) {
list.Add (field);
}
}
}
return (FieldDefinition []) list.ToArray (typeof (FieldDefinition));
}
internal static PropertyDefinition [] GetProperties (TypeDefinition type) {
ArrayList list = new ArrayList ();
var properties = type.Properties;//type.GetProperties (flags);
foreach (PropertyDefinition property in properties) {
MethodDefinition getMethod = property.GetMethod;
MethodDefinition setMethod = property.SetMethod;
bool hasGetter = (getMethod != null) && MustDocumentMethod (getMethod);
bool hasSetter = (setMethod != null) && MustDocumentMethod (setMethod);
// if neither the getter or setter should be documented, then
// skip the property
if (hasGetter || hasSetter) {
list.Add (property);
}
}
return (PropertyDefinition []) list.ToArray (typeof (PropertyDefinition));
}
private MethodDefinition[] GetMethods (TypeDefinition type)
{
ArrayList list = new ArrayList ();
var methods = type.Methods;//type.GetMethods (flags);
foreach (MethodDefinition method in methods) {
if (method.IsSpecialName && !method.Name.StartsWith ("op_"))
continue;
// we're only interested in public or protected members
if (!MustDocumentMethod(method))
continue;
if (IsFinalizer (method)) {
string name = method.DeclaringType.Name;
int arity = name.IndexOf ('`');
if (arity > 0)
name = name.Substring (0, arity);
method.Name = "~" + name;
}
list.Add (method);
}
return (MethodDefinition []) list.ToArray (typeof (MethodDefinition));
}
static bool IsFinalizer (MethodDefinition method)
{
if (method.Name != "Finalize")
return false;
if (!method.IsVirtual)
return false;
if (method.Parameters.Count != 0)
return false;
return true;
}
private MethodDefinition [] GetConstructors (TypeDefinition type)
{
ArrayList list = new ArrayList ();
var ctors = type.Methods.Where (m => m.IsConstructor);//type.GetConstructors (flags);
foreach (MethodDefinition constructor in ctors) {
// we're only interested in public or protected members
if (!MustDocumentMethod(constructor))
continue;
list.Add (constructor);
}
return (MethodDefinition []) list.ToArray (typeof (MethodDefinition));
}
private EventDefinition[] GetEvents (TypeDefinition type)
{
ArrayList list = new ArrayList ();
var events = type.Events;//type.GetEvents (flags);
foreach (EventDefinition eventDef in events) {
MethodDefinition addMethod = eventDef.AddMethod;//eventInfo.GetAddMethod (true);
if (addMethod == null || !MustDocumentMethod (addMethod))
continue;
list.Add (eventDef);
}
return (EventDefinition []) list.ToArray (typeof (EventDefinition));
}
}
class FieldData : MemberData
{
public FieldData (XmlDocument document, XmlNode parent, FieldDefinition [] members)
: base (document, parent, members)
{
}
protected override string GetName (MemberReference memberDefenition)
{
FieldDefinition field = (FieldDefinition) memberDefenition;
return field.Name;
}
protected override string GetMemberAttributes (MemberReference memberDefenition)
{
FieldDefinition field = (FieldDefinition) memberDefenition;
return ((int) field.Attributes).ToString (CultureInfo.InvariantCulture);
}
protected override void AddExtraData (XmlNode p, MemberReference memberDefenition)
{
base.AddExtraData (p, memberDefenition);
FieldDefinition field = (FieldDefinition) memberDefenition;
AddAttribute (p, "fieldtype", Utils.CleanupTypeName (field.FieldType));
if (field.IsLiteral) {
object value = field.Constant;//object value = field.GetValue (null);
string stringValue = null;
//if (value is Enum) {
// // FIXME: when Mono bug #60090 has been
// // fixed, we should just be able to use
// // Convert.ToString
// stringValue = ((Enum) value).ToString ("D", CultureInfo.InvariantCulture);
//}
//else {
stringValue = Convert.ToString (value, CultureInfo.InvariantCulture);
//}
if (stringValue != null)
AddAttribute (p, "value", stringValue);
}
}
public override string ParentTag {
get { return "fields"; }
}
public override string Tag {
get { return "field"; }
}
}
class PropertyData : MemberData
{
public PropertyData (XmlDocument document, XmlNode parent, PropertyDefinition [] members)
: base (document, parent, members)
{
}
protected override string GetName (MemberReference memberDefenition)
{
PropertyDefinition prop = (PropertyDefinition) memberDefenition;
return prop.Name;
}
protected override void AddExtraData (XmlNode p, MemberReference memberDefenition)
{
base.AddExtraData (p, memberDefenition);
PropertyDefinition prop = (PropertyDefinition) memberDefenition;
AddAttribute (p, "ptype", Utils.CleanupTypeName (prop.PropertyType));
MethodDefinition _get = prop.GetMethod;
MethodDefinition _set = prop.SetMethod;
bool haveGet = (_get != null && TypeData.MustDocumentMethod(_get));
bool haveSet = (_set != null && TypeData.MustDocumentMethod(_set));
MethodDefinition [] methods;
if (haveGet && haveSet) {
methods = new MethodDefinition [] { _get, _set };
} else if (haveGet) {
methods = new MethodDefinition [] { _get };
} else if (haveSet) {
methods = new MethodDefinition [] { _set };
} else {
//odd
return;
}
if (haveGet || _set.Parameters.Count > 1) {
string parms = Parameters.GetSignature (methods [0].Parameters);
if (!string.IsNullOrEmpty (parms))
AddAttribute (p, "params", parms);
}
MethodData data = new MethodData (document, p, methods);
//data.NoMemberAttributes = true;
data.DoOutput ();
}
protected override string GetMemberAttributes (MemberReference memberDefenition)
{
PropertyDefinition prop = (PropertyDefinition) memberDefenition;
return ((int) prop.Attributes).ToString (CultureInfo.InvariantCulture);
}
public override string ParentTag {
get { return "properties"; }
}
public override string Tag {
get { return "property"; }
}
}
class EventData : MemberData
{
public EventData (XmlDocument document, XmlNode parent, EventDefinition [] members)
: base (document, parent, members)
{
}
protected override string GetName (MemberReference memberDefenition)
{
EventDefinition evt = (EventDefinition) memberDefenition;
return evt.Name;
}
protected override string GetMemberAttributes (MemberReference memberDefenition)
{
EventDefinition evt = (EventDefinition) memberDefenition;
return ((int) evt.Attributes).ToString (CultureInfo.InvariantCulture);
}
protected override void AddExtraData (XmlNode p, MemberReference memberDefenition)
{
base.AddExtraData (p, memberDefenition);
EventDefinition evt = (EventDefinition) memberDefenition;
AddAttribute (p, "eventtype", Utils.CleanupTypeName (evt.EventType));
}
public override string ParentTag {
get { return "events"; }
}
public override string Tag {
get { return "event"; }
}
}
class MethodData : MemberData
{
bool noAtts;
public MethodData (XmlDocument document, XmlNode parent, MethodDefinition [] members)
: base (document, parent, members)
{
}
protected override string GetName (MemberReference memberDefenition)
{
MethodDefinition method = (MethodDefinition) memberDefenition;
string name = method.Name;
string parms = Parameters.GetSignature (method.Parameters);
return string.Format ("{0}({1})", name, parms);
}
protected override string GetMemberAttributes (MemberReference memberDefenition)
{
MethodDefinition method = (MethodDefinition) memberDefenition;
return ((int)( method.Attributes)).ToString (CultureInfo.InvariantCulture);
}
protected override void AddExtraData (XmlNode p, MemberReference memberDefenition)
{
base.AddExtraData (p, memberDefenition);
if (!(memberDefenition is MethodDefinition))
return;
MethodDefinition mbase = (MethodDefinition) memberDefenition;
ParameterData parms = new ParameterData (document, p, mbase.Parameters);
parms.DoOutput ();
if (mbase.IsAbstract)
AddAttribute (p, "abstract", "true");
if (mbase.IsVirtual)
AddAttribute (p, "virtual", "true");
if (mbase.IsFinal && mbase.IsVirtual && mbase.IsReuseSlot)
AddAttribute (p, "sealed", "true");
if (mbase.IsStatic)
AddAttribute (p, "static", "true");
string rettype = Utils.CleanupTypeName (mbase.MethodReturnType.ReturnType);
if (rettype != "System.Void" || !mbase.IsConstructor)
AddAttribute (p, "returntype", (rettype));
AttributeData.OutputAttributes (document, p, mbase.MethodReturnType);
MemberData.OutputGenericParameters (document, p, mbase);
}
public override bool NoMemberAttributes {
get { return noAtts; }
set { noAtts = value; }
}
public override string ParentTag {
get { return "methods"; }
}
public override string Tag {
get { return "method"; }
}
}
class ConstructorData : MethodData
{
public ConstructorData (XmlDocument document, XmlNode parent, MethodDefinition [] members)
: base (document, parent, members)
{
}
public override string ParentTag {
get { return "constructors"; }
}
public override string Tag {
get { return "constructor"; }
}
}
class ParameterData : BaseData
{
private IList<ParameterDefinition> parameters;
public ParameterData (XmlDocument document, XmlNode parent, IList<ParameterDefinition> parameters)
: base (document, parent)
{
this.parameters = parameters;
}
public override void DoOutput ()
{
XmlNode parametersNode = document.CreateElement ("parameters");
parent.AppendChild (parametersNode);
foreach (ParameterDefinition parameter in parameters) {
XmlNode paramNode = document.CreateElement ("parameter");
parametersNode.AppendChild (paramNode);
AddAttribute (paramNode, "name", parameter.Name);
AddAttribute (paramNode, "position", parameter.Method.Parameters.IndexOf(parameter).ToString(CultureInfo.InvariantCulture));
AddAttribute (paramNode, "attrib", ((int) parameter.Attributes).ToString());
string direction = "in";
if (parameter.ParameterType is ByReferenceType)
direction = parameter.IsOut ? "out" : "ref";
TypeReference t = parameter.ParameterType;
AddAttribute (paramNode, "type", Utils.CleanupTypeName (t));
if (parameter.IsOptional) {
AddAttribute (paramNode, "optional", "true");
if (parameter.HasConstant)
AddAttribute (paramNode, "defaultValue", parameter.Constant == null ? "NULL" : parameter.Constant.ToString ());
}
if (direction != "in")
AddAttribute (paramNode, "direction", direction);
AttributeData.OutputAttributes (document, paramNode, parameter);
}
}
}
class AttributeData : BaseData
{
IList<CustomAttribute> atts;
AttributeData (XmlDocument doc, XmlNode parent, IList<CustomAttribute> attributes)
: base (doc, parent)
{
atts = attributes;
}
public override void DoOutput ()
{
if (document == null)
throw new InvalidOperationException ("Document not set");
if (atts == null || atts.Count == 0)
return;
XmlNode natts = parent.SelectSingleNode("attributes");
if (natts == null) {
natts = document.CreateElement ("attributes", null);
parent.AppendChild (natts);
}
foreach (var att in atts.OrderBy ((a) => a.Constructor.DeclaringType.FullName)) {
string attName = Utils.CleanupTypeName (att.Constructor.DeclaringType);
if (SkipAttribute (att))
continue;
XmlNode node = document.CreateElement ("attribute");
AddAttribute (node, "name", attName);
XmlNode properties = null;
Dictionary<string, object> attribute_mapping = CreateAttributeMapping (att);
foreach (string name in attribute_mapping.Keys) {
if (name == "TypeId")
continue;
if (properties == null) {
properties = node.AppendChild (document.CreateElement ("properties"));
}
object o = attribute_mapping [name];
XmlNode n = properties.AppendChild (document.CreateElement ("property"));
AddAttribute (n, "name", name);
if (o == null) {
AddAttribute (n, "value", "null");
continue;
}
string value = o.ToString ();
if (attName.EndsWith ("GuidAttribute"))
value = value.ToUpper ();
AddAttribute (n, "value", value);
}
natts.AppendChild (node);
}
}
static Dictionary<string, object> CreateAttributeMapping (CustomAttribute attribute)
{
var mapping = new Dictionary<string, object> ();
PopulateMapping (mapping, attribute);
var constructor = attribute.Constructor.Resolve ();
if (constructor == null || !constructor.HasParameters)
return mapping;
PopulateMapping (mapping, constructor, attribute);
return mapping;
}
static void PopulateMapping (Dictionary<string, object> mapping, CustomAttribute attribute)
{
if (!attribute.HasProperties)
return;
foreach (var named_argument in attribute.Properties) {
var name = named_argument.Name;
var arg = named_argument.Argument;
if (arg.Value is CustomAttributeArgument)
arg = (CustomAttributeArgument) arg.Value;
mapping.Add (name, GetArgumentValue (arg.Type, arg.Value));
}
}
static Dictionary<FieldReference, int> CreateArgumentFieldMapping (MethodDefinition constructor)
{
Dictionary<FieldReference, int> field_mapping = new Dictionary<FieldReference, int> ();
int? argument = null;
foreach (Instruction instruction in constructor.Body.Instructions) {
switch (instruction.OpCode.Code) {
case Code.Ldarg_1:
argument = 1;
break;
case Code.Ldarg_2:
argument = 2;
break;
case Code.Ldarg_3:
argument = 3;
break;
case Code.Ldarg:
case Code.Ldarg_S:
argument = ((ParameterDefinition) instruction.Operand).Index + 1;
break;
case Code.Stfld:
FieldReference field = (FieldReference) instruction.Operand;
if (field.DeclaringType.FullName != constructor.DeclaringType.FullName)
continue;
if (!argument.HasValue)
break;
if (!field_mapping.ContainsKey (field))
field_mapping.Add (field, (int) argument - 1);
argument = null;
break;
}
}
return field_mapping;
}
static Dictionary<PropertyDefinition, FieldReference> CreatePropertyFieldMapping (TypeDefinition type)
{
Dictionary<PropertyDefinition, FieldReference> property_mapping = new Dictionary<PropertyDefinition, FieldReference> ();
foreach (PropertyDefinition property in type.Properties) {
if (property.GetMethod == null)
continue;
if (!property.GetMethod.HasBody)
continue;
foreach (Instruction instruction in property.GetMethod.Body.Instructions) {
if (instruction.OpCode.Code != Code.Ldfld)
continue;
FieldReference field = (FieldReference) instruction.Operand;
if (field.DeclaringType.FullName != type.FullName)
continue;
property_mapping.Add (property, field);
break;
}
}
return property_mapping;
}
static void PopulateMapping (Dictionary<string, object> mapping, MethodDefinition constructor, CustomAttribute attribute)
{
if (!constructor.HasBody)
return;
// Custom handling for attributes with arguments which cannot be easily extracted
var ca = attribute.ConstructorArguments;
switch (constructor.DeclaringType.FullName) {
case "System.Runtime.CompilerServices.DecimalConstantAttribute":
var dca = constructor.Parameters[2].ParameterType == constructor.Module.TypeSystem.Int32 ?
new DecimalConstantAttribute ((byte) ca[0].Value, (byte) ca[1].Value, (int) ca[2].Value, (int) ca[3].Value, (int) ca[4].Value) :
new DecimalConstantAttribute ((byte) ca[0].Value, (byte) ca[1].Value, (uint) ca[2].Value, (uint) ca[3].Value, (uint) ca[4].Value);
mapping.Add ("Value", dca.Value);
return;
case "System.ComponentModel.BindableAttribute":
if (ca.Count != 1)
break;
if (constructor.Parameters[0].ParameterType == constructor.Module.TypeSystem.Boolean) {
mapping.Add ("Bindable", ca[0].Value);
} else {
throw new NotImplementedException ();
}
return;
}
var field_mapping = CreateArgumentFieldMapping (constructor);
var property_mapping = CreatePropertyFieldMapping ((TypeDefinition) constructor.DeclaringType);
foreach (var pair in property_mapping) {
int argument;
if (!field_mapping.TryGetValue (pair.Value, out argument))
continue;
var ca_arg = ca [argument];
if (ca_arg.Value is CustomAttributeArgument)
ca_arg = (CustomAttributeArgument) ca_arg.Value;
mapping.Add (pair.Key.Name, GetArgumentValue (ca_arg.Type, ca_arg.Value));
}
}
static object GetArgumentValue (TypeReference reference, object value)
{
var type = reference.Resolve ();
if (type == null)
return value;
if (type.IsEnum) {
if (IsFlaggedEnum (type))
return GetFlaggedEnumValue (type, value);
return GetEnumValue (type, value);
}
return value;
}
static bool IsFlaggedEnum (TypeDefinition type)
{
if (!type.IsEnum)
return false;
if (!type.HasCustomAttributes)
return false;
foreach (CustomAttribute attribute in type.CustomAttributes)
if (attribute.Constructor.DeclaringType.FullName == "System.FlagsAttribute")
return true;
return false;
}
static object GetFlaggedEnumValue (TypeDefinition type, object value)
{
if (value is ulong)
return GetFlaggedEnumValue (type, (ulong)value);
long flags = Convert.ToInt64 (value);
var signature = new StringBuilder ();
for (int i = type.Fields.Count - 1; i >= 0; i--) {
FieldDefinition field = type.Fields [i];
if (!field.HasConstant)
continue;
long flag = Convert.ToInt64 (field.Constant);
if (flag == 0)
continue;
if ((flags & flag) == flag) {
if (signature.Length != 0)
signature.Append (", ");
signature.Append (field.Name);
flags -= flag;
}
}
return signature.ToString ();
}
static object GetFlaggedEnumValue (TypeDefinition type, ulong flags)
{
var signature = new StringBuilder ();
for (int i = type.Fields.Count - 1; i >= 0; i--) {
FieldDefinition field = type.Fields [i];
if (!field.HasConstant)
continue;
ulong flag = Convert.ToUInt64 (field.Constant);
if (flag == 0)
continue;
if ((flags & flag) == flag) {
if (signature.Length != 0)
signature.Append (", ");
signature.Append (field.Name);
flags -= flag;
}
}
return signature.ToString ();
}
static object GetEnumValue (TypeDefinition type, object value)
{
foreach (FieldDefinition field in type.Fields) {
if (!field.HasConstant)
continue;
if (Comparer.Default.Compare (field.Constant, value) == 0)
return field.Name;
}
return value;
}
static bool SkipAttribute (CustomAttribute attribute)
{
var type_name = Utils.CleanupTypeName (attribute.Constructor.DeclaringType);
return !TypeHelper.IsPublic (attribute)
|| type_name.EndsWith ("TODOAttribute");
}
public static void OutputAttributes (XmlDocument doc, XmlNode parent, ICustomAttributeProvider provider)
{
if (!provider.HasCustomAttributes)
return;
AttributeData ad = new AttributeData (doc, parent, provider.CustomAttributes);
ad.DoOutput ();
}
}
static class Parameters {
public static string GetSignature (IList<ParameterDefinition> infos)
{
if (infos == null || infos.Count == 0)
return string.Empty;
var signature = new StringBuilder ();
for (int i = 0; i < infos.Count; i++) {
if (i > 0)
signature.Append (", ");
ParameterDefinition info = infos [i];
string modifier;
if ((info.Attributes & ParameterAttributes.In) != 0)
modifier = "in";
else if ((info.Attributes & ParameterAttributes.Out) != 0)
modifier = "out";
else
modifier = string.Empty;
if (modifier.Length > 0) {
signature.Append (modifier);
signature.Append (" ");
}
signature.Append (Utils.CleanupTypeName (info.ParameterType));
}
return signature.ToString ();
}
}
class TypeReferenceComparer : IComparer<TypeReference>
{
public static TypeReferenceComparer Default = new TypeReferenceComparer ();
public int Compare (TypeReference a, TypeReference b)
{
int result = String.Compare (a.Namespace, b.Namespace, StringComparison.Ordinal);
if (result != 0)
return result;
return String.Compare (a.Name, b.Name, StringComparison.Ordinal);
}
}
class MemberReferenceComparer : IComparer
{
public static MemberReferenceComparer Default = new MemberReferenceComparer ();
public int Compare (object a, object b)
{
MemberReference ma = (MemberReference) a;
MemberReference mb = (MemberReference) b;
return String.Compare (ma.Name, mb.Name, StringComparison.Ordinal);
}
}
class PropertyDefinitionComparer : IComparer<PropertyDefinition>
{
public static PropertyDefinitionComparer Default = new PropertyDefinitionComparer ();
public int Compare (PropertyDefinition ma, PropertyDefinition mb)
{
int res = String.Compare (ma.Name, mb.Name);
if (res != 0)
return res;
if (!ma.HasParameters && !mb.HasParameters)
return 0;
if (!ma.HasParameters)
return -1;
if (!mb.HasParameters)
return 1;
return MethodDefinitionComparer.Compare (ma.Parameters, mb.Parameters);
}
}
class MethodDefinitionComparer : IComparer
{
public static MethodDefinitionComparer Default = new MethodDefinitionComparer ();
public int Compare (object a, object b)
{
MethodDefinition ma = (MethodDefinition) a;
MethodDefinition mb = (MethodDefinition) b;
int res = String.Compare (ma.Name, mb.Name);
if (res != 0)
return res;
if (!ma.HasParameters && !mb.HasParameters)
return 0;
if (!ma.HasParameters)
return -1;
if (!mb.HasParameters)
return 1;
res = Compare (ma.Parameters, mb.Parameters);
if (res != 0)
return res;
// operators can differ by only return type
return string.CompareOrdinal (ma.ReturnType.FullName, mb.ReturnType.FullName);
}
public static int Compare (IList<ParameterDefinition> pia, IList<ParameterDefinition> pib)
{
var res = pia.Count - pib.Count;
if (res != 0)
return res;
string siga = Parameters.GetSignature (pia);
string sigb = Parameters.GetSignature (pib);
return String.Compare (siga, sigb);
}
}
}
|