Merge pull request #3213 from henricm/fix-for-win-securestring-to-bstr
[mono.git] / mcs / tools / corcompare / mono-api-info.cs
1 //
2 // mono-api-info.cs - Dumps public assembly information to an xml file.
3 //
4 // Authors:
5 //      Gonzalo Paniagua Javier (gonzalo@ximian.com)
6 //
7 // Copyright (C) 2003-2008 Novell, Inc (http://www.novell.com)
8 //
9
10 using System;
11 using System.Collections;
12 using System.Collections.Generic;
13 using System.Globalization;
14 using System.Linq;
15 using System.Runtime.CompilerServices;
16 using System.Runtime.InteropServices;
17 using System.Security.Permissions;
18 using System.Text;
19 using System.Xml;
20
21 using Mono.Cecil;
22 using Mono.Cecil.Cil;
23 using System.IO;
24
25 namespace CorCompare
26 {
27         public class Driver
28         {
29                 public static int Main (string [] args)
30                 {
31                         bool showHelp = false;
32                         AbiMode = false;
33                         FollowForwarders = false;
34                         string output = null;
35
36                         var acoll = new AssemblyCollection ();
37
38                         var options = new Mono.Options.OptionSet {
39                                 "usage: mono-api-info [OPTIONS+] ASSEMBLY+",
40                                 "",
41                                 "Expose IL structure of CLR assemblies as XML.",
42                                 "",
43                                 "Available Options:",
44                                 { "abi",
45                                         "Generate ABI, not API; contains only classes with instance fields which are not [NonSerialized].",
46                                         v => AbiMode = v != null },
47                                 { "f|follow-forwarders",
48                                         "Follow type forwarders.",
49                                         v => FollowForwarders = v != null },
50                                 { "d|L|lib|search-directory=",
51                                         "Check for assembly references in {DIRECTORY}.",
52                                         v => TypeHelper.Resolver.AddSearchDirectory (v) },
53                                 { "r=",
54                                         "Read and register the file {ASSEMBLY}, and add the directory containing ASSEMBLY to the search path.",
55                                         v => TypeHelper.Resolver.ResolveFile (v) },
56                                 { "o=",
57                                         "The output file. If not specified the output will be written to stdout.",
58                                         v => output = v },
59                                 { "h|?|help",
60                                         "Show this message and exit.",
61                                         v => showHelp = v != null },
62                                 { "contract-api",
63                                         "Produces contract API with all members at each level of inheritance hierarchy",
64                                         v => FullAPISet = v != null },
65                         };
66
67                         var asms = options.Parse (args);
68
69                         if (showHelp || asms.Count == 0) {
70                                 options.WriteOptionDescriptions (Console.Out);
71                                 Console.WriteLine ();
72                                 return showHelp? 0 :1;
73                         }
74
75                         string windir = Environment.GetFolderPath(Environment.SpecialFolder.Windows);
76                         string pf = Environment.GetFolderPath(Environment.SpecialFolder.ProgramFiles);
77                         TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"assembly\GAC\MSDATASRC\7.0.3300.0__b03f5f7f11d50a3a"));
78
79                         foreach (string arg in asms) {
80                                 acoll.Add (arg);
81
82                                 if (arg.Contains ("v3.0")) {
83                                         TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v2.0.50727"));
84                                 } else if (arg.Contains ("v3.5")) {
85                                         TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v2.0.50727"));
86                                         TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v3.0\Windows Communication Foundation"));
87                                 } else if (arg.Contains ("v4.0")) {
88                                         if (arg.Contains ("Silverlight")) {
89                                                 TypeHelper.Resolver.AddSearchDirectory (Path.Combine (pf, @"Microsoft Silverlight\4.0.51204.0"));
90                                         } else {
91                                                 TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v4.0.30319"));
92                                                 TypeHelper.Resolver.AddSearchDirectory (Path.Combine (windir, @"Microsoft.NET\Framework\v4.0.30319\WPF"));
93                                         }
94                                 } else {
95                                         TypeHelper.Resolver.AddSearchDirectory (Path.GetDirectoryName (arg));
96                                 }
97                         }
98
99                         StreamWriter outputStream = null;
100                         if (!string.IsNullOrEmpty (output))
101                                 outputStream = new StreamWriter (output);
102                         try {
103                                 TextWriter outStream = outputStream ?? Console.Out;
104                                 var settings = new XmlWriterSettings ();
105                                 settings.Indent = true;
106                                 var textWriter = XmlWriter.Create (outStream, settings);
107                                 var writer = new WellFormedXmlWriter (textWriter);
108                                 writer.WriteStartDocument ();
109                                 acoll.Writer = writer;
110                                 acoll.DoOutput ();
111                                 writer.WriteEndDocument ();
112                                 writer.Flush ();
113                         } finally {
114                                 if (outputStream != null)
115                                         outputStream.Dispose ();
116                         }
117                         return 0;
118                 }
119
120                 internal static bool AbiMode { get; private set; }
121                 internal static bool FollowForwarders { get; private set; }
122                 internal static bool FullAPISet { get; set; }
123         }
124
125         public class Utils {
126                 static char[] CharsToCleanup = new char[] { '<', '>', '/' };
127
128                 public static string CleanupTypeName (TypeReference type)
129                 {
130                         return CleanupTypeName (type.FullName);
131                 }
132
133                 public static string CleanupTypeName (string t)
134                 {
135                         if (t.IndexOfAny (CharsToCleanup) == -1)
136                                 return t;
137                         var sb = new StringBuilder (t.Length);
138                         for (int i = 0; i < t.Length; i++) {
139                                 var ch = t [i];
140                                 switch (ch) {
141                                 case '<':
142                                         sb.Append ('[');
143                                         break;
144                                 case '>':
145                                         sb.Append (']');
146                                         break;
147                                 case '/':
148                                         sb.Append ('+');
149                                         break;
150                                 default:
151                                         sb.Append (ch);
152                                         break;
153                                 }
154                         }
155                         return sb.ToString ();
156                 }
157         }
158
159         class AssemblyCollection
160         {
161                 XmlWriter writer;
162                 List<AssemblyDefinition> assemblies = new List<AssemblyDefinition> ();
163
164                 public AssemblyCollection ()
165                 {
166                 }
167
168                 public bool Add (string name)
169                 {
170                         AssemblyDefinition ass = LoadAssembly (name);
171                         if (ass == null) {
172                                 Console.Error.WriteLine ("Cannot load assembly file " + name);
173                                 return false;
174                         }
175
176                         assemblies.Add (ass);
177                         return true;
178                 }
179
180                 public void DoOutput ()
181                 {
182                         if (writer == null)
183                                 throw new InvalidOperationException ("Document not set");
184
185                         writer.WriteStartElement ("assemblies");
186                         foreach (AssemblyDefinition a in assemblies) {
187                                 AssemblyData data = new AssemblyData (writer, a);
188                                 data.DoOutput ();
189                         }
190                         writer.WriteEndElement ();
191                 }
192
193                 public XmlWriter Writer {
194                         set { writer = value; }
195                 }
196
197                 AssemblyDefinition LoadAssembly (string assembly)
198                 {
199                         try {
200                                 if (File.Exists (assembly))
201                                         return TypeHelper.Resolver.ResolveFile (assembly);
202
203                                 return TypeHelper.Resolver.Resolve (assembly);
204                         } catch (Exception e) {
205                                 Console.WriteLine (e);
206                                 return null;
207                         }
208                 }
209         }
210
211         abstract class BaseData
212         {
213                 protected XmlWriter writer;
214
215                 protected BaseData (XmlWriter writer)
216                 {
217                         this.writer = writer;
218                 }
219
220                 public abstract void DoOutput ();
221
222                 protected void AddAttribute (string name, string value)
223                 {
224                         writer.WriteAttributeString (name, value);
225                 }
226         }
227
228         class TypeForwardedToData : BaseData
229         {
230                 AssemblyDefinition ass;
231
232                 public TypeForwardedToData (XmlWriter writer, AssemblyDefinition ass)
233                         : base (writer)
234                 {
235                         this.ass = ass;
236                 }
237
238                 public override void DoOutput ()
239                 {
240                         foreach (ExportedType type in ass.MainModule.ExportedTypes) {
241
242                                 if (((uint)type.Attributes & 0x200000u) == 0)
243                                         continue;
244
245                                 writer.WriteStartElement ("attribute");
246                                 AddAttribute ("name", typeof (TypeForwardedToAttribute).FullName);
247                                 writer.WriteStartElement ("properties");
248                                 writer.WriteStartElement ("property");
249                                 AddAttribute ("name", "Destination");
250                                 AddAttribute ("value", Utils.CleanupTypeName (type.FullName));
251                                 writer.WriteEndElement (); // properties
252                                 writer.WriteEndElement (); // properties
253                                 writer.WriteEndElement (); // attribute
254                         }
255                 }
256
257                 public static void OutputForwarders (XmlWriter writer, AssemblyDefinition ass)
258                 {
259                         TypeForwardedToData tftd = new TypeForwardedToData (writer, ass);
260                         tftd.DoOutput ();
261                 }
262         }
263
264         class AssemblyData : BaseData
265         {
266                 AssemblyDefinition ass;
267
268                 public AssemblyData (XmlWriter writer, AssemblyDefinition ass)
269                         : base (writer)
270                 {
271                         this.ass = ass;
272                 }
273
274                 public override void DoOutput ()
275                 {
276                         if (writer == null)
277                                 throw new InvalidOperationException ("Document not set");
278
279                         writer.WriteStartElement ("assembly");
280                         AssemblyNameDefinition aname = ass.Name;
281                         AddAttribute ("name", aname.Name);
282                         AddAttribute ("version", aname.Version.ToString ());
283
284                         AttributeData.OutputAttributes (writer, ass);
285
286                         var types = new List<TypeDefinition> ();
287                         if (ass.MainModule.Types != null) {
288                                 types.AddRange (ass.MainModule.Types);
289                         }
290
291                         if (Driver.FollowForwarders && ass.MainModule.ExportedTypes != null) {
292                                 foreach (var t in ass.MainModule.ExportedTypes) {
293                                         var forwarded = t.Resolve ();
294                                         if (forwarded == null) {
295                                                 throw new Exception ("Could not resolve forwarded type " + t.FullName + " in " + ass.Name);
296                                         }
297                                         types.Add (forwarded);
298                                 }
299                         }
300
301                         if (types.Count == 0) {
302                                 writer.WriteEndElement (); // assembly
303                                 return;
304                         }
305
306                         types.Sort (TypeReferenceComparer.Default);
307
308                         writer.WriteStartElement ("namespaces");
309
310                         string current_namespace = "$%&$&";
311                         bool in_namespace = false;
312                         foreach (TypeDefinition t in types) {
313                                 if (string.IsNullOrEmpty (t.Namespace))
314                                         continue;
315
316                                 if (!Driver.AbiMode && ((t.Attributes & TypeAttributes.VisibilityMask) != TypeAttributes.Public))
317                                         continue;
318
319                                 if (t.DeclaringType != null)
320                                         continue; // enforce !nested
321
322                                 if (t.Namespace != current_namespace) {
323                                         current_namespace = t.Namespace;
324                                         if (in_namespace) {
325                                                 writer.WriteEndElement (); // classes
326                                                 writer.WriteEndElement (); // namespace
327                                         } else {
328                                                 in_namespace = true;
329                                         }
330                                         writer.WriteStartElement ("namespace");
331                                         AddAttribute ("name", current_namespace);
332                                         writer.WriteStartElement ("classes");
333                                 }
334
335                                 TypeData bd = new TypeData (writer, t);
336                                 bd.DoOutput ();
337
338                         }
339
340                         if (in_namespace) {
341                                 writer.WriteEndElement (); // classes
342                                 writer.WriteEndElement (); // namespace
343                         }
344
345                         writer.WriteEndElement (); // namespaces
346
347                         writer.WriteEndElement (); // assembly
348                 }
349         }
350
351         abstract class MemberData : BaseData
352         {
353                 MemberReference [] members;
354
355                 public MemberData (XmlWriter writer, MemberReference [] members)
356                         : base (writer)
357                 {
358                         this.members = members;
359                 }
360
361                 protected virtual ICustomAttributeProvider GetAdditionalCustomAttributeProvider (MemberReference member)
362                 {
363                         return null;
364                 }
365
366                 public override void DoOutput ()
367                 {
368                         writer.WriteStartElement (ParentTag);
369
370                         foreach (MemberReference member in members) {
371                                 writer.WriteStartElement (Tag);
372                                 AddAttribute ("name", GetName (member));
373                                 if (!NoMemberAttributes)
374                                         AddAttribute ("attrib", GetMemberAttributes (member));
375                                 AddExtraAttributes (member);
376
377                                 AttributeData.OutputAttributes (writer, (ICustomAttributeProvider) member, GetAdditionalCustomAttributeProvider (member));
378
379                                 AddExtraData (member);
380                                 writer.WriteEndElement (); // Tag
381                         }
382
383                         writer.WriteEndElement (); // ParentTag
384                 }
385
386                 protected virtual void AddExtraData (MemberReference memberDefenition)
387                 {
388                 }
389
390                 protected virtual void AddExtraAttributes (MemberReference memberDefinition)
391                 {
392                 }
393
394                 protected virtual string GetName (MemberReference memberDefenition)
395                 {
396                         return "NoNAME";
397                 }
398
399                 protected virtual string GetMemberAttributes (MemberReference memberDefenition)
400                 {
401                         return null;
402                 }
403
404                 public virtual bool NoMemberAttributes {
405                         get { return false; }
406                         set {}
407                 }
408
409                 public virtual string ParentTag {
410                         get { return "NoPARENTTAG"; }
411                 }
412
413                 public virtual string Tag {
414                         get { return "NoTAG"; }
415                 }
416
417                 public static void OutputGenericParameters (XmlWriter writer, IGenericParameterProvider provider)
418                 {
419                         if (provider.GenericParameters.Count == 0)
420                                 return;
421
422                         var gparameters = provider.GenericParameters;
423
424                         writer.WriteStartElement ("generic-parameters");
425
426                         foreach (GenericParameter gp in gparameters) {
427                                 writer.WriteStartElement ("generic-parameter");
428                                 writer.WriteAttributeString ("name", gp.Name);
429                                 writer.WriteAttributeString ("attributes", ((int) gp.Attributes).ToString ());
430
431                                 AttributeData.OutputAttributes (writer, gp);
432
433                                 var constraints = gp.Constraints;
434                                 if (constraints.Count == 0) {
435                                         writer.WriteEndElement (); // generic-parameter
436                                         continue;
437                                 }
438
439                                 writer.WriteStartElement ("generic-parameter-constraints");
440
441                                 foreach (TypeReference constraint in constraints) {
442                                         writer.WriteStartElement ("generic-parameter-constraint");
443                                         writer.WriteAttributeString ("name", Utils.CleanupTypeName (constraint));
444                                         writer.WriteEndElement (); // generic-parameter-constraint
445                                 }
446
447                                 writer.WriteEndElement (); // generic-parameter-constraints
448
449                                 writer.WriteEndElement (); // generic-parameter
450                         }
451
452                         writer.WriteEndElement (); // generic-parameters
453                 }
454         }
455
456         class TypeData : MemberData
457         {
458                 TypeDefinition type;
459
460                 public TypeData (XmlWriter writer, TypeDefinition type)
461                         : base (writer, null)
462                 {
463                         this.type = type;
464                 }
465                 public override void DoOutput ()
466                 {
467                         if (writer == null)
468                                 throw new InvalidOperationException ("Document not set");
469
470                         writer.WriteStartElement ("class");
471                         AddAttribute ("name", type.Name);
472                         string classType = GetClassType (type);
473                         AddAttribute ("type", classType);
474
475                         if (type.BaseType != null)
476                                 AddAttribute ("base", Utils.CleanupTypeName (type.BaseType));
477
478                         if (type.IsSealed)
479                                 AddAttribute ("sealed", "true");
480
481                         if (type.IsAbstract)
482                                 AddAttribute ("abstract", "true");
483
484                         if ( (type.Attributes & TypeAttributes.Serializable) != 0 || type.IsEnum)
485                                 AddAttribute ("serializable", "true");
486
487                         string charSet = GetCharSet (type);
488                         AddAttribute ("charset", charSet);
489
490                         string layout = GetLayout (type);
491                         if (layout != null)
492                                 AddAttribute ("layout", layout);
493
494                         if (type.PackingSize >= 0) {
495                                 AddAttribute ("pack", type.PackingSize.ToString ());
496                         }
497
498                         if (type.ClassSize >= 0) {
499                                 AddAttribute ("size", type.ClassSize.ToString ());
500                         }
501
502                         if (type.IsEnum) {
503                                 var value_type = GetEnumValueField (type);
504                                 if (value_type == null)
505                                         throw new NotSupportedException ();
506
507                                 AddAttribute ("enumtype", Utils.CleanupTypeName (value_type.FieldType));
508                         }
509
510                         AttributeData.OutputAttributes (writer, type);
511
512                         var ifaces =  TypeHelper.GetInterfaces (type).
513                                 Where ((iface) => TypeHelper.IsPublic (iface)). // we're only interested in public interfaces
514                                 OrderBy (s => s.FullName, StringComparer.Ordinal);
515
516                         if (ifaces.Any ()) {
517                                 writer.WriteStartElement ("interfaces");
518                                 foreach (TypeReference iface in ifaces) {
519                                         writer.WriteStartElement ("interface");
520                                         AddAttribute ("name", Utils.CleanupTypeName (iface));
521                                         writer.WriteEndElement (); // interface
522                                 }
523                                 writer.WriteEndElement (); // interfaces
524                         }
525
526                         MemberData.OutputGenericParameters (writer, type);
527
528                         ArrayList members = new ArrayList ();
529
530                         FieldDefinition [] fields = GetFields (type);
531                         if (fields.Length > 0) {
532                                 Array.Sort (fields, MemberReferenceComparer.Default);
533                                 FieldData fd = new FieldData (writer, fields);
534                                 members.Add (fd);
535                         }
536
537                         if (!Driver.AbiMode) {
538
539                                 MethodDefinition [] ctors = GetConstructors (type);
540                                 if (ctors.Length > 0) {
541                                         Array.Sort (ctors, MethodDefinitionComparer.Default);
542                                         members.Add (new ConstructorData (writer, ctors));
543                                 }
544
545                                 PropertyDefinition[] properties = GetProperties (type, Driver.FullAPISet);
546                                 if (properties.Length > 0) {
547                                         Array.Sort (properties, PropertyDefinitionComparer.Default);
548                                         members.Add (new PropertyData (writer, properties));
549                                 }
550
551                                 EventDefinition [] events = GetEvents (type);
552                                 if (events.Length > 0) {
553                                         Array.Sort (events, MemberReferenceComparer.Default);
554                                         members.Add (new EventData (writer, events));
555                                 }
556
557                                 MethodDefinition [] methods = GetMethods (type, Driver.FullAPISet);
558                                 if (methods.Length > 0) {
559                                         Array.Sort (methods, MethodDefinitionComparer.Default);
560                                         members.Add (new MethodData (writer, methods));
561                                 }
562                         }
563
564                         foreach (MemberData md in members)
565                                 md.DoOutput ();
566
567                         var nested = type.NestedTypes;
568                         //remove non public(familiy) and nested in second degree
569                         for (int i = nested.Count - 1; i >= 0; i--) {
570                                 TypeDefinition t = nested [i];
571                                 if ((t.Attributes & TypeAttributes.VisibilityMask) == TypeAttributes.NestedPublic ||
572                                         (t.Attributes & TypeAttributes.VisibilityMask) == TypeAttributes.NestedFamily ||
573                                         (t.Attributes & TypeAttributes.VisibilityMask) == TypeAttributes.NestedFamORAssem) {
574                                         // public
575                                         if (t.DeclaringType == type)
576                                                 continue; // not nested of nested
577                                 }
578
579                                 nested.RemoveAt (i);
580                         }
581
582                         if (nested.Count > 0) {
583                                 var nestedArray = nested.ToArray ();
584                                 Array.Sort (nestedArray, TypeReferenceComparer.Default);
585
586                                 writer.WriteStartElement ("classes");
587                                 foreach (TypeDefinition t in nestedArray) {
588                                         TypeData td = new TypeData (writer, t);
589                                         td.DoOutput ();
590                                 }
591                                 writer.WriteEndElement (); // classes
592                         }
593
594                         writer.WriteEndElement (); // class
595                 }
596
597                 static FieldReference GetEnumValueField (TypeDefinition type)
598                 {
599                         foreach (FieldDefinition field in type.Fields)
600                                 if (field.IsSpecialName && field.Name == "value__")
601                                         return field;
602
603                         return null;
604                 }
605
606                 protected override string GetMemberAttributes (MemberReference member)
607                 {
608                         if (member != type)
609                                 throw new InvalidOperationException ("odd");
610
611                         return ((int) type.Attributes).ToString (CultureInfo.InvariantCulture);
612                 }
613
614                 public static bool MustDocumentMethod (MethodDefinition method) {
615                         // All other methods
616                         MethodAttributes maskedAccess = method.Attributes & MethodAttributes.MemberAccessMask;
617                         return maskedAccess == MethodAttributes.Public
618                                 || maskedAccess == MethodAttributes.Family
619                                 || maskedAccess == MethodAttributes.FamORAssem;
620                 }
621
622                 static string GetClassType (TypeDefinition t)
623                 {
624                         if (t.IsEnum)
625                                 return "enum";
626
627                         if (t.IsValueType)
628                                 return "struct";
629
630                         if (t.IsInterface)
631                                 return "interface";
632
633                         if (TypeHelper.IsDelegate(t))
634                                 return "delegate";
635
636                         if (t.IsPointer)
637                                 return "pointer";
638
639                         return "class";
640                 }
641
642                 static string GetCharSet (TypeDefinition type)
643                 {
644                         TypeAttributes maskedStringFormat = type.Attributes & TypeAttributes.StringFormatMask;
645                         if (maskedStringFormat == TypeAttributes.AnsiClass)
646                                 return CharSet.Ansi.ToString ();
647
648                         if (maskedStringFormat == TypeAttributes.AutoClass)
649                                 return CharSet.Auto.ToString ();
650
651                         if (maskedStringFormat == TypeAttributes.UnicodeClass)
652                                 return CharSet.Unicode.ToString ();
653
654                         return CharSet.None.ToString ();
655                 }
656
657                 static string GetLayout (TypeDefinition type)
658                 {
659                         TypeAttributes maskedLayout = type.Attributes & TypeAttributes.LayoutMask;
660                         if (maskedLayout == TypeAttributes.AutoLayout)
661                                 return LayoutKind.Auto.ToString ();
662
663                         if (maskedLayout == TypeAttributes.ExplicitLayout)
664                                 return LayoutKind.Explicit.ToString ();
665
666                         if (maskedLayout == TypeAttributes.SequentialLayout)
667                                 return LayoutKind.Sequential.ToString ();
668
669                         return null;
670                 }
671
672                 FieldDefinition [] GetFields (TypeDefinition type) {
673                         ArrayList list = new ArrayList ();
674
675                         var fields = type.Fields;
676                         foreach (FieldDefinition field in fields) {
677                                 if (field.IsSpecialName)
678                                         continue;
679
680                                 if (Driver.AbiMode && field.IsStatic)
681                                         continue;
682
683                                 // we're only interested in public or protected members
684                                 FieldAttributes maskedVisibility = (field.Attributes & FieldAttributes.FieldAccessMask);
685                                 if (Driver.AbiMode && !field.IsNotSerialized) {
686                                         list.Add (field);
687                                 } else {
688                                         if (maskedVisibility == FieldAttributes.Public
689                                                 || maskedVisibility == FieldAttributes.Family
690                                                 || maskedVisibility == FieldAttributes.FamORAssem) {
691                                                 list.Add (field);
692                                         }
693                                 }
694                         }
695
696                         return (FieldDefinition []) list.ToArray (typeof (FieldDefinition));
697                 }
698
699
700                 internal static PropertyDefinition [] GetProperties (TypeDefinition type, bool fullAPI) {
701                         var list = new List<PropertyDefinition> ();
702
703                         var t = type;
704                         do {
705                                 var properties = t.Properties;//type.GetProperties (flags);
706                                 foreach (PropertyDefinition property in properties) {
707                                         MethodDefinition getMethod = property.GetMethod;
708                                         MethodDefinition setMethod = property.SetMethod;
709
710                                         bool hasGetter = (getMethod != null) && MustDocumentMethod (getMethod);
711                                         bool hasSetter = (setMethod != null) && MustDocumentMethod (setMethod);
712
713                                         // if neither the getter or setter should be documented, then
714                                         // skip the property
715                                         if (hasGetter || hasSetter) {
716
717                                                 if (t != type && list.Any (l => l.Name == property.Name))
718                                                         continue;
719
720                                                 list.Add (property);
721                                         }
722                                 }
723
724                                 if (!fullAPI)
725                                         break;
726
727                                 if (t.IsInterface || t.IsEnum)
728                                         break;
729
730                                 if (t.BaseType == null || t.BaseType.FullName == "System.Object")
731                                         t = null;
732                                 else
733                                         t = t.BaseType.Resolve ();
734
735                         } while (t != null);
736
737                         return list.ToArray ();
738                 }
739
740                 private MethodDefinition[] GetMethods (TypeDefinition type, bool fullAPI)
741                 {
742                         var list = new List<MethodDefinition> ();
743
744                         var t = type;
745                         do {
746                                 var methods = t.Methods;//type.GetMethods (flags);
747                                 foreach (MethodDefinition method in methods) {
748                                         if (method.IsSpecialName && !method.Name.StartsWith ("op_", StringComparison.Ordinal))
749                                                 continue;
750
751                                         // we're only interested in public or protected members
752                                         if (!MustDocumentMethod (method))
753                                                 continue;
754
755                                         if (t == type && IsFinalizer (method)) {
756                                                 string name = method.DeclaringType.Name;
757                                                 int arity = name.IndexOf ('`');
758                                                 if (arity > 0)
759                                                         name = name.Substring (0, arity);
760
761                                                 method.Name = "~" + name;
762                                         }
763
764                                         // TODO: Better check
765                                         if (t != type && list.Any (l => l.DeclaringType != method.DeclaringType && l.Name == method.Name && l.Parameters.Count == method.Parameters.Count))
766                                                 continue;
767
768                                         list.Add (method);
769                                 }
770
771                                 if (!fullAPI)
772                                         break;
773
774                                 if (!t.IsInterface || t.IsEnum)
775                                         break;
776
777                                 if (t.BaseType == null || t.BaseType.FullName == "System.Object")
778                                         t = null;
779                                 else
780                                         t = t.BaseType.Resolve ();
781
782                         } while (t != null);
783
784                         return list.ToArray ();
785                 }
786
787                 static bool IsFinalizer (MethodDefinition method)
788                 {
789                         if (method.Name != "Finalize")
790                                 return false;
791
792                         if (!method.IsVirtual)
793                                 return false;
794
795                         if (method.Parameters.Count != 0)
796                                 return false;
797
798                         return true;
799                 }
800
801                 private MethodDefinition [] GetConstructors (TypeDefinition type)
802                 {
803                         ArrayList list = new ArrayList ();
804
805                         var ctors = type.Methods.Where (m => m.IsConstructor);//type.GetConstructors (flags);
806                         foreach (MethodDefinition constructor in ctors) {
807                                 // we're only interested in public or protected members
808                                 if (!MustDocumentMethod(constructor))
809                                         continue;
810
811                                 list.Add (constructor);
812                         }
813
814                         return (MethodDefinition []) list.ToArray (typeof (MethodDefinition));
815                 }
816
817                 private EventDefinition[] GetEvents (TypeDefinition type)
818                 {
819                         ArrayList list = new ArrayList ();
820
821                         var events = type.Events;//type.GetEvents (flags);
822                         foreach (EventDefinition eventDef in events) {
823                                 MethodDefinition addMethod = eventDef.AddMethod;//eventInfo.GetAddMethod (true);
824
825                                 if (addMethod == null || !MustDocumentMethod (addMethod))
826                                         continue;
827
828                                 list.Add (eventDef);
829                         }
830
831                         return (EventDefinition []) list.ToArray (typeof (EventDefinition));
832                 }
833         }
834
835         class FieldData : MemberData
836         {
837                 public FieldData (XmlWriter writer, FieldDefinition [] members)
838                         : base (writer, members)
839                 {
840                 }
841
842                 protected override string GetName (MemberReference memberDefenition)
843                 {
844                         FieldDefinition field = (FieldDefinition) memberDefenition;
845                         return field.Name;
846                 }
847
848                 protected override string GetMemberAttributes (MemberReference memberDefenition)
849                 {
850                         FieldDefinition field = (FieldDefinition) memberDefenition;
851                         return ((int) field.Attributes).ToString (CultureInfo.InvariantCulture);
852                 }
853
854                 protected override void AddExtraAttributes (MemberReference memberDefinition)
855                 {
856                         base.AddExtraAttributes (memberDefinition);
857
858                         FieldDefinition field = (FieldDefinition) memberDefinition;
859                         AddAttribute ("fieldtype", Utils.CleanupTypeName (field.FieldType));
860
861                         if (field.IsLiteral) {
862                                 object value = field.Constant;//object value = field.GetValue (null);
863                                 string stringValue = null;
864                                 //if (value is Enum) {
865                                 //    // FIXME: when Mono bug #60090 has been
866                                 //    // fixed, we should just be able to use
867                                 //    // Convert.ToString
868                                 //    stringValue = ((Enum) value).ToString ("D", CultureInfo.InvariantCulture);
869                                 //}
870                                 //else {
871                                 stringValue = Convert.ToString (value, CultureInfo.InvariantCulture);
872                                 //}
873
874                                 if (stringValue != null)
875                                         AddAttribute ("value", stringValue);
876                         }
877                 }
878
879                 public override string ParentTag {
880                         get { return "fields"; }
881                 }
882
883                 public override string Tag {
884                         get { return "field"; }
885                 }
886         }
887
888         class PropertyData : MemberData
889         {
890                 public PropertyData (XmlWriter writer, PropertyDefinition [] members)
891                         : base (writer, members)
892                 {
893                 }
894
895                 protected override string GetName (MemberReference memberDefenition)
896                 {
897                         PropertyDefinition prop = (PropertyDefinition) memberDefenition;
898                         return prop.Name;
899                 }
900
901                 MethodDefinition [] GetMethods (PropertyDefinition prop, out bool haveParameters)
902                 {
903                         MethodDefinition _get = prop.GetMethod;
904                         MethodDefinition _set = prop.SetMethod;
905                         bool haveGet = (_get != null && TypeData.MustDocumentMethod(_get));
906                         bool haveSet = (_set != null && TypeData.MustDocumentMethod(_set));
907                         haveParameters = haveGet || (haveSet && _set.Parameters.Count > 1);
908                         MethodDefinition [] methods;
909
910                         if (haveGet && haveSet) {
911                                 methods = new MethodDefinition [] { _get, _set };
912                         } else if (haveGet) {
913                                 methods = new MethodDefinition [] { _get };
914                         } else if (haveSet) {
915                                 methods = new MethodDefinition [] { _set };
916                         } else {
917                                 //odd
918                                 return null;
919                         }
920
921                         return methods;
922                 }
923
924                 protected override void AddExtraAttributes (MemberReference memberDefinition)
925                 {
926                         base.AddExtraAttributes (memberDefinition);
927
928                         PropertyDefinition prop = (PropertyDefinition) memberDefinition;
929                         AddAttribute ("ptype", Utils.CleanupTypeName (prop.PropertyType));
930
931                         bool haveParameters;
932                         MethodDefinition [] methods = GetMethods ((PropertyDefinition) memberDefinition, out haveParameters);
933
934                         if (methods != null && haveParameters) {
935                                 string parms = Parameters.GetSignature (methods [0].Parameters);
936                                 if (!string.IsNullOrEmpty (parms))
937                                         AddAttribute ("params", parms);
938                         }
939
940                 }
941
942                 protected override void AddExtraData (MemberReference memberDefenition)
943                 {
944                         base.AddExtraData (memberDefenition);
945
946                         bool haveParameters;
947                         MethodDefinition [] methods = GetMethods ((PropertyDefinition) memberDefenition, out haveParameters);
948
949                         if (methods == null)
950                                 return;
951                         
952                         MethodData data = new MethodData (writer, methods);
953                         //data.NoMemberAttributes = true;
954                         data.DoOutput ();
955                 }
956
957                 protected override string GetMemberAttributes (MemberReference memberDefenition)
958                 {
959                         PropertyDefinition prop = (PropertyDefinition) memberDefenition;
960                         return ((int) prop.Attributes).ToString (CultureInfo.InvariantCulture);
961                 }
962
963                 public override string ParentTag {
964                         get { return "properties"; }
965                 }
966
967                 public override string Tag {
968                         get { return "property"; }
969                 }
970         }
971
972         class EventData : MemberData
973         {
974                 public EventData (XmlWriter writer, EventDefinition [] members)
975                         : base (writer, members)
976                 {
977                 }
978
979                 protected override string GetName (MemberReference memberDefenition)
980                 {
981                         EventDefinition evt = (EventDefinition) memberDefenition;
982                         return evt.Name;
983                 }
984
985                 protected override string GetMemberAttributes (MemberReference memberDefenition)
986                 {
987                         EventDefinition evt = (EventDefinition) memberDefenition;
988                         return ((int) evt.Attributes).ToString (CultureInfo.InvariantCulture);
989                 }
990
991                 protected override void AddExtraAttributes (MemberReference memberDefinition)
992                 {
993                         base.AddExtraAttributes (memberDefinition);
994
995                         EventDefinition evt = (EventDefinition) memberDefinition;
996                         AddAttribute ("eventtype", Utils.CleanupTypeName (evt.EventType));
997                 }
998
999                 public override string ParentTag {
1000                         get { return "events"; }
1001                 }
1002
1003                 public override string Tag {
1004                         get { return "event"; }
1005                 }
1006         }
1007
1008         class MethodData : MemberData
1009         {
1010                 bool noAtts;
1011
1012                 public MethodData (XmlWriter writer, MethodDefinition [] members)
1013                         : base (writer, members)
1014                 {
1015                 }
1016
1017                 protected override string GetName (MemberReference memberDefenition)
1018                 {
1019                         MethodDefinition method = (MethodDefinition) memberDefenition;
1020                         string name = method.Name;
1021                         string parms = Parameters.GetSignature (method.Parameters);
1022
1023                         return string.Format ("{0}({1})", name, parms);
1024                 }
1025
1026                 protected override string GetMemberAttributes (MemberReference memberDefenition)
1027                 {
1028                         MethodDefinition method = (MethodDefinition) memberDefenition;
1029                         return ((int)( method.Attributes)).ToString (CultureInfo.InvariantCulture);
1030                 }
1031
1032                 protected override ICustomAttributeProvider GetAdditionalCustomAttributeProvider (MemberReference member)
1033                 {
1034                         var mbase = (MethodDefinition) member;
1035                         return mbase.MethodReturnType;
1036                 }
1037
1038                 protected override void AddExtraAttributes (MemberReference memberDefinition)
1039                 {
1040                         base.AddExtraAttributes (memberDefinition);
1041
1042                         if (!(memberDefinition is MethodDefinition))
1043                                 return;
1044
1045                         MethodDefinition mbase = (MethodDefinition) memberDefinition;
1046
1047                         if (mbase.IsAbstract)
1048                                 AddAttribute ("abstract", "true");
1049                         if (mbase.IsVirtual)
1050                                 AddAttribute ("virtual", "true");
1051                         if (mbase.IsFinal && mbase.IsVirtual && mbase.IsReuseSlot)
1052                                 AddAttribute ("sealed", "true");
1053                         if (mbase.IsStatic)
1054                                 AddAttribute ("static", "true");
1055                         var baseMethod = TypeHelper.GetBaseMethodInTypeHierarchy (mbase);
1056                         if (baseMethod != null && baseMethod != mbase) {
1057                                 // This indicates whether this method is an override of another method.
1058                                 // This information is not necessarily available in the api info for any
1059                                 // particular assembly, because a method is only overriding another if
1060                                 // there is a base virtual function with the same signature, and that
1061                                 // base method can come from another assembly.
1062                                 AddAttribute ("is-override", "true");
1063                         }
1064                         string rettype = Utils.CleanupTypeName (mbase.MethodReturnType.ReturnType);
1065                         if (rettype != "System.Void" || !mbase.IsConstructor)
1066                                 AddAttribute ("returntype", (rettype));
1067 //
1068 //                      if (mbase.MethodReturnType.HasCustomAttributes)
1069 //                              AttributeData.OutputAttributes (writer, mbase.MethodReturnType);
1070                 }
1071
1072                 protected override void AddExtraData (MemberReference memberDefenition)
1073                 {
1074                         base.AddExtraData (memberDefenition);
1075
1076                         if (!(memberDefenition is MethodDefinition))
1077                                 return;
1078
1079                         MethodDefinition mbase = (MethodDefinition) memberDefenition;
1080
1081                         ParameterData parms = new ParameterData (writer, mbase.Parameters);
1082                         parms.DoOutput ();
1083
1084                         MemberData.OutputGenericParameters (writer, mbase);
1085                 }
1086
1087                 public override bool NoMemberAttributes {
1088                         get { return noAtts; }
1089                         set { noAtts = value; }
1090                 }
1091
1092                 public override string ParentTag {
1093                         get { return "methods"; }
1094                 }
1095
1096                 public override string Tag {
1097                         get { return "method"; }
1098                 }
1099         }
1100
1101         class ConstructorData : MethodData
1102         {
1103                 public ConstructorData (XmlWriter writer, MethodDefinition [] members)
1104                         : base (writer, members)
1105                 {
1106                 }
1107
1108                 public override string ParentTag {
1109                         get { return "constructors"; }
1110                 }
1111
1112                 public override string Tag {
1113                         get { return "constructor"; }
1114                 }
1115         }
1116
1117         class ParameterData : BaseData
1118         {
1119                 private IList<ParameterDefinition> parameters;
1120
1121                 public ParameterData (XmlWriter writer, IList<ParameterDefinition> parameters)
1122                         : base (writer)
1123                 {
1124                         this.parameters = parameters;
1125                 }
1126
1127                 public override void DoOutput ()
1128                 {
1129                         writer.WriteStartElement ("parameters");
1130                         foreach (ParameterDefinition parameter in parameters) {
1131                                 writer.WriteStartElement ("parameter");
1132                                 AddAttribute ("name", parameter.Name);
1133                                 AddAttribute ("position", parameter.Method.Parameters.IndexOf(parameter).ToString(CultureInfo.InvariantCulture));
1134                                 AddAttribute ("attrib", ((int) parameter.Attributes).ToString());
1135
1136                                 string direction = "in";
1137
1138                                 if (parameter.ParameterType is ByReferenceType)
1139                                         direction = parameter.IsOut ? "out" : "ref";
1140
1141                                 TypeReference t = parameter.ParameterType;
1142                                 AddAttribute ("type", Utils.CleanupTypeName (t));
1143
1144                                 if (parameter.IsOptional) {
1145                                         AddAttribute ("optional", "true");
1146                                         if (parameter.HasConstant)
1147                                                 AddAttribute ("defaultValue", parameter.Constant == null ? "NULL" : parameter.Constant.ToString ());
1148                                 }
1149
1150                                 if (direction != "in")
1151                                         AddAttribute ("direction", direction);
1152
1153                                 AttributeData.OutputAttributes (writer, parameter);
1154                                 writer.WriteEndElement (); // parameter
1155                         }
1156                         writer.WriteEndElement (); // parameters
1157                 }
1158         }
1159
1160         class AttributeData
1161         {
1162                 public static void DoOutput (XmlWriter writer, IList<ICustomAttributeProvider> providers)
1163                 {
1164                         if (writer == null)
1165                                 throw new InvalidOperationException ("Document not set");
1166
1167                         if (providers == null || providers.Count == 0)
1168                                 return;
1169                 
1170                         if (!providers.Any ((provider) => provider != null && provider.HasCustomAttributes))
1171                                 return;
1172
1173                         writer.WriteStartElement ("attributes");
1174
1175                         foreach (var provider in providers) {
1176                                 if (provider == null)
1177                                         continue;
1178                                 
1179                                 if (!provider.HasCustomAttributes)
1180                                         continue;
1181
1182
1183                                 var ass = provider as AssemblyDefinition;
1184                                 if (ass != null && !Driver.FollowForwarders)
1185                                         TypeForwardedToData.OutputForwarders (writer, ass);
1186
1187                                 var attributes = provider.CustomAttributes.
1188                                         Where ((att) => !SkipAttribute (att)).
1189                                         OrderBy ((a) => a.Constructor.DeclaringType.FullName, StringComparer.Ordinal);
1190                                 
1191                                 foreach (var att in attributes) {
1192                                         string attName = Utils.CleanupTypeName (att.Constructor.DeclaringType);
1193
1194                                         writer.WriteStartElement ("attribute");
1195                                         writer.WriteAttributeString ("name", attName);
1196
1197                                         var attribute_mapping = CreateAttributeMapping (att);
1198
1199                                         if (attribute_mapping != null) {
1200                                                 var mapping = attribute_mapping.Where ((attr) => attr.Key != "TypeId");
1201                                                 if (mapping.Any ()) {
1202                                                         writer.WriteStartElement ("properties");
1203                                                         foreach (var kvp in mapping) {
1204                                                                 string name = kvp.Key;
1205                                                                 object o = kvp.Value;
1206
1207                                                                 writer.WriteStartElement ("property");
1208                                                                 writer.WriteAttributeString ("name", name);
1209
1210                                                                 if (o == null) {
1211                                                                         writer.WriteAttributeString ("value", "null");
1212                                                                 } else {
1213                                                                         string value = o.ToString ();
1214                                                                         if (attName.EndsWith ("GuidAttribute", StringComparison.Ordinal))
1215                                                                                 value = value.ToUpper ();
1216                                                                         writer.WriteAttributeString ("value", value);
1217                                                                 }
1218
1219                                                                 writer.WriteEndElement (); // property
1220                                                         }
1221                                                         writer.WriteEndElement (); // properties
1222                                                 }
1223                                         }
1224                                         writer.WriteEndElement (); // attribute
1225                                 }
1226                         }
1227
1228                         writer.WriteEndElement (); // attributes
1229                 }
1230
1231                 static Dictionary<string, object> CreateAttributeMapping (CustomAttribute attribute)
1232                 {
1233                         Dictionary<string, object> mapping = null;
1234
1235                         PopulateMapping (ref mapping, attribute);
1236
1237                         var constructor = attribute.Constructor.Resolve ();
1238                         if (constructor == null || !constructor.HasParameters)
1239                                 return mapping;
1240
1241                         PopulateMapping (ref mapping, constructor, attribute);
1242
1243                         return mapping;
1244                 }
1245
1246                 static void PopulateMapping (ref Dictionary<string, object> mapping, CustomAttribute attribute)
1247                 {
1248                         if (!attribute.HasProperties)
1249                                 return;
1250                         
1251                         foreach (var named_argument in attribute.Properties) {
1252                                 var name = named_argument.Name;
1253                                 var arg = named_argument.Argument;
1254
1255                                 if (arg.Value is CustomAttributeArgument)
1256                                         arg = (CustomAttributeArgument) arg.Value;
1257
1258                                 if (mapping == null)
1259                                         mapping = new Dictionary<string, object> (StringComparer.Ordinal);
1260                                 mapping.Add (name, GetArgumentValue (arg.Type, arg.Value));
1261                         }
1262                 }
1263
1264                 static Dictionary<FieldReference, int> CreateArgumentFieldMapping (MethodDefinition constructor)
1265                 {
1266                         Dictionary<FieldReference, int> field_mapping = null;
1267
1268                         int? argument = null;
1269
1270                         foreach (Instruction instruction in constructor.Body.Instructions) {
1271                                 switch (instruction.OpCode.Code) {
1272                                 case Code.Ldarg_1:
1273                                         argument = 1;
1274                                         break;
1275                                 case Code.Ldarg_2:
1276                                         argument = 2;
1277                                         break;
1278                                 case Code.Ldarg_3:
1279                                         argument = 3;
1280                                         break;
1281                                 case Code.Ldarg:
1282                                 case Code.Ldarg_S:
1283                                         argument = ((ParameterDefinition) instruction.Operand).Index + 1;
1284                                         break;
1285
1286                                 case Code.Stfld:
1287                                         FieldReference field = (FieldReference) instruction.Operand;
1288                                         if (field.DeclaringType.FullName != constructor.DeclaringType.FullName)
1289                                                 continue;
1290
1291                                         if (!argument.HasValue)
1292                                                 break;
1293
1294                                         if (field_mapping == null)
1295                                                 field_mapping = new Dictionary<FieldReference, int> ();
1296                                         
1297                                         if (!field_mapping.ContainsKey (field))
1298                                                 field_mapping.Add (field, (int) argument - 1);
1299
1300                                         argument = null;
1301                                         break;
1302                                 }
1303                         }
1304
1305                         return field_mapping;
1306                 }
1307
1308                 static Dictionary<PropertyDefinition, FieldReference> CreatePropertyFieldMapping (TypeDefinition type)
1309                 {
1310                         Dictionary<PropertyDefinition, FieldReference> property_mapping = null;
1311
1312                         foreach (PropertyDefinition property in type.Properties) {
1313                                 if (property.GetMethod == null)
1314                                         continue;
1315                                 if (!property.GetMethod.HasBody)
1316                                         continue;
1317
1318                                 foreach (Instruction instruction in property.GetMethod.Body.Instructions) {
1319                                         if (instruction.OpCode.Code != Code.Ldfld)
1320                                                 continue;
1321
1322                                         FieldReference field = (FieldReference) instruction.Operand;
1323                                         if (field.DeclaringType.FullName != type.FullName)
1324                                                 continue;
1325
1326                                         if (property_mapping == null)
1327                                                 property_mapping = new Dictionary<PropertyDefinition, FieldReference> ();
1328                                         property_mapping.Add (property, field);
1329                                         break;
1330                                 }
1331                         }
1332
1333                         return property_mapping;
1334                 }
1335
1336                 static void PopulateMapping (ref Dictionary<string, object> mapping, MethodDefinition constructor, CustomAttribute attribute)
1337                 {
1338                         if (!constructor.HasBody)
1339                                 return;
1340
1341                         // Custom handling for attributes with arguments which cannot be easily extracted
1342                         var ca = attribute.ConstructorArguments;
1343                         switch (constructor.DeclaringType.FullName) {
1344                         case "System.Runtime.CompilerServices.DecimalConstantAttribute":
1345                                 var dca = constructor.Parameters[2].ParameterType == constructor.Module.TypeSystem.Int32 ?
1346                                         new DecimalConstantAttribute ((byte) ca[0].Value, (byte) ca[1].Value, (int) ca[2].Value, (int) ca[3].Value, (int) ca[4].Value) :
1347                                         new DecimalConstantAttribute ((byte) ca[0].Value, (byte) ca[1].Value, (uint) ca[2].Value, (uint) ca[3].Value, (uint) ca[4].Value);
1348
1349                                 if (mapping == null)
1350                                         mapping = new Dictionary<string, object> (StringComparer.Ordinal);
1351                                 mapping.Add ("Value", dca.Value);
1352                                 return;
1353                         case "System.ComponentModel.BindableAttribute":
1354                                 if (ca.Count != 1)
1355                                         break;
1356
1357                                 if (constructor.Parameters[0].ParameterType == constructor.Module.TypeSystem.Boolean) {
1358                                         if (mapping == null)
1359                                                 mapping = new Dictionary<string, object> (StringComparer.Ordinal);
1360                                         mapping.Add ("Bindable", ca[0].Value);
1361                                 } else {
1362                                         throw new NotImplementedException ();
1363                                 }
1364
1365                                 return;
1366                         }
1367
1368                         var field_mapping = CreateArgumentFieldMapping (constructor);
1369                         if (field_mapping != null) { 
1370                                 var property_mapping = CreatePropertyFieldMapping ((TypeDefinition) constructor.DeclaringType);
1371
1372                                 if (property_mapping != null) {
1373                                         foreach (var pair in property_mapping) {
1374                                                 int argument;
1375                                                 if (!field_mapping.TryGetValue (pair.Value, out argument))
1376                                                         continue;
1377
1378                                                 var ca_arg = ca [argument];
1379                                                 if (ca_arg.Value is CustomAttributeArgument)
1380                                                         ca_arg = (CustomAttributeArgument)ca_arg.Value;
1381
1382                                                 if (mapping == null)
1383                                                         mapping = new Dictionary<string, object> (StringComparer.Ordinal);
1384                                                 mapping.Add (pair.Key.Name, GetArgumentValue (ca_arg.Type, ca_arg.Value));
1385                                         }
1386                                 }
1387                         }
1388                 }
1389
1390                 static object GetArgumentValue (TypeReference reference, object value)
1391                 {
1392                         var type = reference.Resolve ();
1393                         if (type == null)
1394                                 return value;
1395
1396                         if (type.IsEnum) {
1397                                 if (IsFlaggedEnum (type))
1398                                         return GetFlaggedEnumValue (type, value);
1399
1400                                 return GetEnumValue (type, value);
1401                         }
1402
1403                         return value;
1404                 }
1405
1406                 static bool IsFlaggedEnum (TypeDefinition type)
1407                 {
1408                         if (!type.IsEnum)
1409                                 return false;
1410
1411                         if (!type.HasCustomAttributes)
1412                                 return false;
1413
1414                         foreach (CustomAttribute attribute in type.CustomAttributes)
1415                                 if (attribute.Constructor.DeclaringType.FullName == "System.FlagsAttribute")
1416                                         return true;
1417
1418                         return false;
1419                 }
1420
1421                 static object GetFlaggedEnumValue (TypeDefinition type, object value)
1422                 {
1423                         if (value is ulong)
1424                                 return GetFlaggedEnumValue (type, (ulong)value);
1425
1426                         long flags = Convert.ToInt64 (value);
1427                         var signature = new StringBuilder ();
1428
1429                         for (int i = type.Fields.Count - 1; i >= 0; i--) {
1430                                 FieldDefinition field = type.Fields [i];
1431
1432                                 if (!field.HasConstant)
1433                                         continue;
1434
1435                                 long flag = Convert.ToInt64 (field.Constant);
1436
1437                                 if (flag == 0)
1438                                         continue;
1439
1440                                 if ((flags & flag) == flag) {
1441                                         if (signature.Length != 0)
1442                                                 signature.Append (", ");
1443
1444                                         signature.Append (field.Name);
1445                                         flags -= flag;
1446                                 }
1447                         }
1448
1449                         return signature.ToString ();
1450                 }
1451
1452                 static object GetFlaggedEnumValue (TypeDefinition type, ulong flags)
1453                 {
1454                         var signature = new StringBuilder ();
1455
1456                         for (int i = type.Fields.Count - 1; i >= 0; i--) {
1457                                 FieldDefinition field = type.Fields [i];
1458
1459                                 if (!field.HasConstant)
1460                                         continue;
1461
1462                                 ulong flag = Convert.ToUInt64 (field.Constant);
1463
1464                                 if (flag == 0)
1465                                         continue;
1466
1467                                 if ((flags & flag) == flag) {
1468                                         if (signature.Length != 0)
1469                                                 signature.Append (", ");
1470
1471                                         signature.Append (field.Name);
1472                                         flags -= flag;
1473                                 }
1474                         }
1475
1476                         return signature.ToString ();
1477                 }
1478
1479                 static object GetEnumValue (TypeDefinition type, object value)
1480                 {
1481                         foreach (FieldDefinition field in type.Fields) {
1482                                 if (!field.HasConstant)
1483                                         continue;
1484
1485                                 if (Comparer.Default.Compare (field.Constant, value) == 0)
1486                                         return field.Name;
1487                         }
1488
1489                         return value;
1490                 }
1491
1492                 static bool SkipAttribute (CustomAttribute attribute)
1493                 {
1494                         if (!TypeHelper.IsPublic (attribute))
1495                                 return true;
1496                         
1497                         return attribute.Constructor.DeclaringType.Name.EndsWith ("TODOAttribute", StringComparison.Ordinal);
1498                 }
1499
1500                 public static void OutputAttributes (XmlWriter writer, params ICustomAttributeProvider[] providers)
1501                 {
1502                         AttributeData.DoOutput (writer, providers);
1503                 }
1504         }
1505
1506         static class Parameters {
1507
1508                 public static string GetSignature (IList<ParameterDefinition> infos)
1509                 {
1510                         if (infos == null || infos.Count == 0)
1511                                 return string.Empty;
1512
1513                         var signature = new StringBuilder ();
1514                         for (int i = 0; i < infos.Count; i++) {
1515
1516                                 if (i > 0)
1517                                         signature.Append (", ");
1518
1519                                 ParameterDefinition info = infos [i];
1520
1521                                 string modifier;
1522                                 if ((info.Attributes & ParameterAttributes.In) != 0)
1523                                         modifier = "in";
1524                                 else if ((info.Attributes & ParameterAttributes.Out) != 0)
1525                                         modifier = "out";
1526                                 else
1527                                         modifier = string.Empty;
1528
1529                                 if (modifier.Length > 0) {
1530                                         signature.Append (modifier);
1531                                         signature.Append (" ");
1532                                 }
1533
1534                                 signature.Append (Utils.CleanupTypeName (info.ParameterType));
1535                         }
1536
1537                         return signature.ToString ();
1538                 }
1539
1540         }
1541
1542         class TypeReferenceComparer : IComparer<TypeReference>
1543         {
1544                 public static TypeReferenceComparer Default = new TypeReferenceComparer ();
1545
1546                 public int Compare (TypeReference a, TypeReference b)
1547                 {
1548                         int result = String.Compare (a.Namespace, b.Namespace, StringComparison.Ordinal);
1549                         if (result != 0)
1550                                 return result;
1551
1552                         return String.Compare (a.Name, b.Name, StringComparison.Ordinal);
1553                 }
1554         }
1555
1556         class MemberReferenceComparer : IComparer
1557         {
1558                 public static MemberReferenceComparer Default = new MemberReferenceComparer ();
1559
1560                 public int Compare (object a, object b)
1561                 {
1562                         MemberReference ma = (MemberReference) a;
1563                         MemberReference mb = (MemberReference) b;
1564                         return String.Compare (ma.Name, mb.Name, StringComparison.Ordinal);
1565                 }
1566         }
1567
1568         class PropertyDefinitionComparer : IComparer<PropertyDefinition>
1569         {
1570                 public static PropertyDefinitionComparer Default = new PropertyDefinitionComparer ();
1571
1572                 public int Compare (PropertyDefinition ma, PropertyDefinition mb)
1573                 {
1574                         int res = String.Compare (ma.Name, mb.Name, StringComparison.Ordinal);
1575                         if (res != 0)
1576                                 return res;
1577
1578                         if (!ma.HasParameters && !mb.HasParameters)
1579                                 return 0;
1580
1581                         if (!ma.HasParameters)
1582                                 return -1;
1583
1584                         if (!mb.HasParameters)
1585                                 return 1;
1586
1587                         return MethodDefinitionComparer.Compare (ma.Parameters, mb.Parameters);
1588                 }
1589         }
1590
1591         class MethodDefinitionComparer : IComparer
1592         {
1593                 public static MethodDefinitionComparer Default = new MethodDefinitionComparer ();
1594
1595                 public int Compare (object a, object b)
1596                 {
1597                         MethodDefinition ma = (MethodDefinition) a;
1598                         MethodDefinition mb = (MethodDefinition) b;
1599                         int res = String.Compare (ma.Name, mb.Name, StringComparison.Ordinal);
1600                         if (res != 0)
1601                                 return res;
1602
1603                         if (!ma.HasParameters && !mb.HasParameters)
1604                                 return 0;
1605
1606                         if (!ma.HasParameters)
1607                                 return -1;
1608
1609                         if (!mb.HasParameters)
1610                                 return 1;
1611
1612                         res = Compare (ma.Parameters, mb.Parameters);
1613                         if (res != 0)
1614                                 return res;
1615
1616                         if (ma.HasGenericParameters != mb.HasGenericParameters)
1617                                 return ma.HasGenericParameters ? -1 : 1;
1618
1619                         if (ma.HasGenericParameters && mb.HasGenericParameters) {
1620                                 res = ma.GenericParameters.Count - mb.GenericParameters.Count;
1621                                 if (res != 0)
1622                                         return res;
1623                         }
1624
1625                         // operators can differ by only return type
1626                         return string.CompareOrdinal (ma.ReturnType.FullName, mb.ReturnType.FullName);
1627                 }
1628
1629                 public static int Compare (IList<ParameterDefinition> pia, IList<ParameterDefinition> pib)
1630                 {
1631                         var res = pia.Count - pib.Count;
1632                         if (res != 0)
1633                                 return res;
1634
1635                         string siga = Parameters.GetSignature (pia);
1636                         string sigb = Parameters.GetSignature (pib);
1637                         return String.Compare (siga, sigb, StringComparison.Ordinal);
1638                 }
1639         }
1640 }
1641