mcs/tools/mdoc/Mono.Documentation/monodocer.cs

   1 // Updater program for syncing Mono's ECMA-style documentation files
   2 // with an assembly.
   3 // By Joshua Tauberer <tauberer@for.net>
   4
   5 using System;
   6 using System.Collections;
   7 using System.Collections.Generic;
   8 using System.Diagnostics;
   9 using System.Globalization;
  10 using System.IO;
  11 using System.Linq;
  12 using System.Text;
  13 using System.Xml;
  14 using System.Xml.XPath;
  15
  16 using Mono.Cecil;
  17 using Mono.Options;
  18
  19 using MyXmlNodeList        = System.Collections.Generic.List<System.Xml.XmlNode>;
  20 using StringList           = System.Collections.Generic.List<string>;
  21 using StringToStringMap    = System.Collections.Generic.Dictionary<string, string>;
  22 using StringToXmlNodeMap   = System.Collections.Generic.Dictionary<string, System.Xml.XmlNode>;
  23
  24 namespace Mono.Documentation {
  25
  26 class MDocUpdater : MDocCommand
  27 {
  28         string srcPath;
  29         List<AssemblyDefinition> assemblies;
  30         readonly DefaultAssemblyResolver assemblyResolver = new DefaultAssemblyResolver();
  31
  32         bool delete;
  33         bool show_exceptions;
  34         bool no_assembly_versions, ignore_missing_types;
  35         ExceptionLocations? exceptions;
  36
  37         internal int additions = 0, deletions = 0;
  38
  39         List<DocumentationImporter> importers = new List<DocumentationImporter> ();
  40
  41         DocumentationEnumerator docEnum;
  42
  43         string since;
  44
  45         static readonly MemberFormatter docTypeFormatter     = new DocTypeMemberFormatter ();
  46         static readonly MemberFormatter filenameFormatter    = new FileNameMemberFormatter ();
  47
  48         static MemberFormatter[] typeFormatters = new MemberFormatter[]{
  49                 new CSharpMemberFormatter (),
  50                 new ILMemberFormatter (),
  51         };
  52
  53         static MemberFormatter[] memberFormatters = new MemberFormatter[]{
  54                 new CSharpFullMemberFormatter (),
  55                 new ILFullMemberFormatter (),
  56         };
  57
  58         internal static readonly MemberFormatter slashdocFormatter    = new SlashDocMemberFormatter ();
  59
  60         MyXmlNodeList extensionMethods = new MyXmlNodeList ();
  61
  62         public override void Run (IEnumerable<string> args)
  63         {
  64                 show_exceptions = DebugOutput;
  65                 var types = new List<string> ();
  66                 var p = new OptionSet () {
  67                         { "delete",
  68                                 "Delete removed members from the XML files.",
  69                                 v => delete = v != null },
  70                         { "exceptions:",
  71                           "Document potential exceptions that members can generate.  {SOURCES} " +
  72                                 "is a comma-separated list of:\n" +
  73                                 "  asm      Method calls in same assembly\n" +
  74                                 "  depasm   Method calls in dependent assemblies\n" +
  75                                 "  all      Record all possible exceptions\n" +
  76                                 "  added    Modifier; only create <exception/>s\n" +
  77                                 "             for NEW types/members\n" +
  78                                 "If nothing is specified, then only exceptions from the member will " +
  79                                 "be listed.",
  80                                 v => exceptions = ParseExceptionLocations (v) },
  81                         { "f=",
  82                                 "Specify a {FLAG} to alter behavior.  See later -f* options for available flags.",
  83                                 v => {
  84                                         switch (v) {
  85                                                 case "ignore-missing-types":
  86                                                         ignore_missing_types = true;
  87                                                         break;
  88                                                 case "no-assembly-versions":
  89                                                         no_assembly_versions = true;
  90                                                         break;
  91                                                 default:
  92                                                         throw new Exception ("Unsupported flag `" + v + "'.");
  93                                         }
  94                                 } },
  95                         { "fignore-missing-types",
  96                                 "Do not report an error if a --type=TYPE type\nwas not found.",
  97                                 v => ignore_missing_types = v != null },
  98                         { "fno-assembly-versions",
  99                                 "Do not generate //AssemblyVersion elements.",
 100                                 v => no_assembly_versions = v != null },
 101                         { "i|import=",
 102                                 "Import documentation from {FILE}.",
 103                                 v => AddImporter (v) },
 104                         { "L|lib=",
 105                                 "Check for assembly references in {DIRECTORY}.",
 106                                 v => assemblyResolver.AddSearchDirectory (v) },
 107                         { "library=",
 108                                 "Ignored for compatibility with update-ecma-xml.",
 109                                 v => {} },
 110                         { "o|out=",
 111                                 "Root {DIRECTORY} to generate/update documentation.",
 112                                 v => srcPath = v },
 113                         { "r=",
 114                                 "Search for dependent assemblies in the directory containing {ASSEMBLY}.\n" +
 115                                 "(Equivalent to '-L `dirname ASSEMBLY`'.)",
 116                                 v => assemblyResolver.AddSearchDirectory (Path.GetDirectoryName (v)) },
 117                         { "since=",
 118                                 "Manually specify the assembly {VERSION} that new members were added in.",
 119                                 v => since = v },
 120                         { "type=",
 121                           "Only update documentation for {TYPE}.",
 122                                 v => types.Add (v) },
 123                 };
 124                 var assemblies = Parse (p, args, "update",
 125                                 "[OPTIONS]+ ASSEMBLIES",
 126                                 "Create or update documentation from ASSEMBLIES.");
 127                 if (assemblies == null)
 128                         return;
 129                 if (assemblies.Count == 0)
 130                         Error ("No assemblies specified.");
 131
 132                 foreach (var dir in assemblies
 133                                 .Where (a => a.Contains (Path.DirectorySeparatorChar))
 134                                 .Select (a => Path.GetDirectoryName (a)))
 135                         assemblyResolver.AddSearchDirectory (dir);
 136
 137                 // PARSE BASIC OPTIONS AND LOAD THE ASSEMBLY TO DOCUMENT
 138
 139                 if (srcPath == null)
 140                         throw new InvalidOperationException("The --out option is required.");
 141
 142                 this.assemblies = assemblies.Select (a => LoadAssembly (a)).ToList ();
 143
 144                 docEnum = docEnum ?? new DocumentationEnumerator ();
 145
 146                 // PERFORM THE UPDATES
 147
 148                 if (types.Count > 0) {
 149                         types.Sort ();
 150                         DoUpdateTypes (srcPath, types, srcPath);
 151                 }
 152 #if false
 153                 else if (opts.@namespace != null)
 154                         DoUpdateNS (opts.@namespace, Path.Combine (opts.path, opts.@namespace),
 155                                         Path.Combine (dest_dir, opts.@namespace));
 156 #endif
 157                 else
 158                         DoUpdateAssemblies (srcPath, srcPath);
 159
 160                 Console.WriteLine("Members Added: {0}, Members Deleted: {1}", additions, deletions);
 161         }
 162
 163         void AddImporter (string path)
 164         {
 165                 try {
 166                         XmlReader r = new XmlTextReader (path);
 167                         if (r.Read ()) {
 168                                 while (r.NodeType != XmlNodeType.Element) {
 169                                         if (!r.Read ())
 170                                                 Error ("Unable to read XML file: {0}.", path);
 171                                 }
 172                                 if (r.LocalName == "doc") {
 173                                         importers.Add (new MsxdocDocumentationImporter (path));
 174                                 }
 175                                 else if (r.LocalName == "Libraries") {
 176                                         var ecmadocs = new XmlTextReader (path);
 177                                         docEnum = new EcmaDocumentationEnumerator (this, ecmadocs);
 178                                         importers.Add (new EcmaDocumentationImporter (ecmadocs));
 179                                 }
 180                                 else
 181                                         Error ("Unsupported XML format within {0}.", path);
 182                         }
 183                         r.Close ();
 184                 } catch (Exception e) {
 185                         Environment.ExitCode = 1;
 186                         Error ("Could not load XML file: {0}.", e.Message);
 187                 }
 188         }
 189
 190         static ExceptionLocations ParseExceptionLocations (string s)
 191         {
 192                 ExceptionLocations loc = ExceptionLocations.Member;
 193                 if (s == null)
 194                         return loc;
 195                 foreach (var type in s.Split (',')) {
 196                         switch (type) {
 197                                 case "added":   loc |= ExceptionLocations.AddedMembers; break;
 198                                 case "all":     loc |= ExceptionLocations.Assembly | ExceptionLocations.DependentAssemblies; break;
 199                                 case "asm":     loc |= ExceptionLocations.Assembly; break;
 200                                 case "depasm":  loc |= ExceptionLocations.DependentAssemblies; break;
 201                                 default:        throw new NotSupportedException ("Unsupported --exceptions value: " + type);
 202                         }
 203                 }
 204                 return loc;
 205         }
 206
 207         internal void Warning (string format, params object[] args)
 208         {
 209                 Message (TraceLevel.Warning, "mdoc: " + format, args);
 210         }
 211
 212         private AssemblyDefinition LoadAssembly (string name)
 213         {
 214                 AssemblyDefinition assembly = null;
 215                 try {
 216                         assembly = AssemblyDefinition.ReadAssembly (name, new ReaderParameters { AssemblyResolver = assemblyResolver });
 217                 } catch (System.IO.FileNotFoundException) { }
 218
 219                 if (assembly == null)
 220                         throw new InvalidOperationException("Assembly " + name + " not found.");
 221
 222                 return assembly;
 223         }
 224
 225         private static void WriteXml(XmlElement element, System.IO.TextWriter output) {
 226                 OrderTypeAttributes (element);
 227                 XmlTextWriter writer = new XmlTextWriter(output);
 228                 writer.Formatting = Formatting.Indented;
 229                 writer.Indentation = 2;
 230                 writer.IndentChar = ' ';
 231                 element.WriteTo(writer);
 232                 output.WriteLine();
 233         }
 234
 235         private static void WriteFile (string filename, FileMode mode, Action<TextWriter> action)
 236         {
 237                 Action<string> creator = file => {
 238                         using (var writer = OpenWrite (file, mode))
 239                                 action (writer);
 240                 };
 241
 242                 MdocFile.UpdateFile (filename, creator);
 243         }
 244
 245         private static void OrderTypeAttributes (XmlElement e)
 246         {
 247                 foreach (XmlElement type in e.SelectNodes ("//Type")) {
 248                         OrderTypeAttributes (type.Attributes);
 249                 }
 250         }
 251
 252         static readonly string[] TypeAttributeOrder = {
 253                 "Name", "FullName", "FullNameSP", "Maintainer"
 254         };
 255
 256         private static void OrderTypeAttributes (XmlAttributeCollection c)
 257         {
 258                 XmlAttribute[] attrs = new XmlAttribute [TypeAttributeOrder.Length];
 259                 for (int i = 0; i < c.Count; ++i) {
 260                         XmlAttribute a = c [i];
 261                         for (int j = 0; j < TypeAttributeOrder.Length; ++j) {
 262                                 if (a.Name == TypeAttributeOrder [j]) {
 263                                         attrs [j] = a;
 264                                         break;
 265                                 }
 266                         }
 267                 }
 268                 for (int i = attrs.Length-1; i >= 0; --i) {
 269                         XmlAttribute n = attrs [i];
 270                         if (n == null)
 271                                 continue;
 272                         XmlAttribute r = null;
 273                         for (int j = i+1; j < attrs.Length; ++j) {
 274                                 if (attrs [j] != null) {
 275                                         r = attrs [j];
 276                                         break;
 277                                 }
 278                         }
 279                         if (r == null)
 280                                 continue;
 281                         c.Remove (n);
 282                         c.InsertBefore (n, r);
 283                 }
 284         }
 285
 286         private XmlDocument CreateIndexStub()
 287         {
 288                 XmlDocument index = new XmlDocument();
 289
 290                 XmlElement index_root = index.CreateElement("Overview");
 291                 index.AppendChild(index_root);
 292
 293                 if (assemblies.Count == 0)
 294                         throw new Exception ("No assembly");
 295
 296                 XmlElement index_assemblies = index.CreateElement("Assemblies");
 297                 index_root.AppendChild(index_assemblies);
 298
 299                 XmlElement index_remarks = index.CreateElement("Remarks");
 300                 index_remarks.InnerText = "To be added.";
 301                 index_root.AppendChild(index_remarks);
 302
 303                 XmlElement index_copyright = index.CreateElement("Copyright");
 304                 index_copyright.InnerText = "To be added.";
 305                 index_root.AppendChild(index_copyright);
 306
 307                 XmlElement index_types = index.CreateElement("Types");
 308                 index_root.AppendChild(index_types);
 309
 310                 return index;
 311         }
 312
 313         private static void WriteNamespaceStub(string ns, string outdir) {
 314                 XmlDocument index = new XmlDocument();
 315
 316                 XmlElement index_root = index.CreateElement("Namespace");
 317                 index.AppendChild(index_root);
 318
 319                 index_root.SetAttribute("Name", ns);
 320
 321                 XmlElement index_docs = index.CreateElement("Docs");
 322                 index_root.AppendChild(index_docs);
 323
 324                 XmlElement index_summary = index.CreateElement("summary");
 325                 index_summary.InnerText = "To be added.";
 326                 index_docs.AppendChild(index_summary);
 327
 328                 XmlElement index_remarks = index.CreateElement("remarks");
 329                 index_remarks.InnerText = "To be added.";
 330                 index_docs.AppendChild(index_remarks);
 331
 332                 WriteFile (outdir + "/ns-" + ns + ".xml", FileMode.CreateNew,
 333                                 writer => WriteXml (index.DocumentElement, writer));
 334         }
 335
 336         public void DoUpdateTypes (string basepath, List<string> typenames, string dest)
 337         {
 338                 var index = CreateIndexForTypes (dest);
 339
 340                 var found = new HashSet<string> ();
 341                 foreach (AssemblyDefinition assembly in assemblies) {
 342                         foreach (TypeDefinition type in docEnum.GetDocumentationTypes (assembly, typenames)) {
 343                                 string relpath = DoUpdateType (type, basepath, dest);
 344                                 if (relpath == null)
 345                                         continue;
 346
 347                                 found.Add (type.FullName);
 348
 349                                 if (index == null)
 350                                         continue;
 351
 352                                 index.Add (assembly);
 353                                 index.Add (type);
 354                         }
 355                 }
 356
 357                 if (index != null)
 358                         index.Write ();
 359
 360                 if (ignore_missing_types)
 361                         return;
 362
 363                 var notFound = from n in typenames where !found.Contains (n) select n;
 364                 if (notFound.Any ())
 365                         throw new InvalidOperationException("Type(s) not found: " + string.Join (", ", notFound.ToArray ()));
 366         }
 367
 368         class IndexForTypes {
 369
 370                 MDocUpdater app;
 371                 string indexFile;
 372
 373                 XmlDocument index;
 374                 XmlElement index_types;
 375                 XmlElement index_assemblies;
 376
 377                 public IndexForTypes (MDocUpdater app, string indexFile, XmlDocument index)
 378                 {
 379                         this.app        = app;
 380                         this.indexFile  = indexFile;
 381                         this.index      = index;
 382
 383                         index_types = WriteElement (index.DocumentElement, "Types");
 384                         index_assemblies = WriteElement (index.DocumentElement, "Assemblies");
 385                 }
 386
 387                 public void Add (AssemblyDefinition assembly)
 388                 {
 389                         if (index_assemblies.SelectSingleNode ("Assembly[@Name='" + assembly.Name.Name + "']") != null)
 390                                 return;
 391
 392                         app.AddIndexAssembly (assembly, index_assemblies);
 393                 }
 394
 395                 public void Add (TypeDefinition type)
 396                 {
 397                         app.AddIndexType (type, index_types);
 398                 }
 399
 400                 public void Write ()
 401                 {
 402                         SortIndexEntries (index_types);
 403                         WriteFile (indexFile, FileMode.Create,
 404                                         writer => WriteXml (index.DocumentElement, writer));
 405                 }
 406         }
 407
 408         IndexForTypes CreateIndexForTypes (string dest)
 409         {
 410                 string indexFile = Path.Combine (dest, "index.xml");
 411                 if (File.Exists (indexFile))
 412                         return null;
 413                 return new IndexForTypes (this, indexFile, CreateIndexStub ());
 414         }
 415
 416         public string DoUpdateType (TypeDefinition type, string basepath, string dest)
 417         {
 418                 if (type.Namespace == null)
 419                         Warning ("warning: The type `{0}' is in the root namespace.  This may cause problems with display within monodoc.",
 420                                         type.FullName);
 421                 if (!IsPublic (type))
 422                         return null;
 423
 424                 // Must get the A+B form of the type name.
 425                 string typename = GetTypeFileName(type);
 426
 427                 string reltypefile = DocUtils.PathCombine (DocUtils.GetNamespace (type), typename + ".xml");
 428                 string typefile = Path.Combine (basepath, reltypefile);
 429                 System.IO.FileInfo file = new System.IO.FileInfo(typefile);
 430
 431                 string output = null;
 432                 if (dest == null) {
 433                         output = typefile;
 434                 } else if (dest == "-") {
 435                         output = null;
 436                 } else {
 437                         output = Path.Combine (dest, reltypefile);
 438                 }
 439
 440                 if (file.Exists) {
 441                         // Update
 442                         XmlDocument basefile = new XmlDocument();
 443                         try {
 444                                 basefile.Load(typefile);
 445                         } catch (Exception e) {
 446                                 throw new InvalidOperationException("Error loading " + typefile + ": " + e.Message, e);
 447                         }
 448
 449                         DoUpdateType2("Updating", basefile, type, output, false);
 450                 } else {
 451                         // Stub
 452                         XmlElement td = StubType(type, output);
 453                         if (td == null)
 454                                 return null;
 455
 456                         System.IO.DirectoryInfo dir = new System.IO.DirectoryInfo (DocUtils.PathCombine (dest, type.Namespace));
 457                         if (!dir.Exists) {
 458                                 dir.Create();
 459                                 Console.WriteLine("Namespace Directory Created: " + type.Namespace);
 460                         }
 461                 }
 462                 return reltypefile;
 463         }
 464
 465         public void DoUpdateNS (string ns, string nspath, string outpath)
 466         {
 467                 Dictionary<TypeDefinition, object> seenTypes = new Dictionary<TypeDefinition,object> ();
 468                 AssemblyDefinition                  assembly = assemblies [0];
 469
 470                 foreach (System.IO.FileInfo file in new System.IO.DirectoryInfo(nspath).GetFiles("*.xml")) {
 471                         XmlDocument basefile = new XmlDocument();
 472                         string typefile = Path.Combine(nspath, file.Name);
 473                         try {
 474                                 basefile.Load(typefile);
 475                         } catch (Exception e) {
 476                                 throw new InvalidOperationException("Error loading " + typefile + ": " + e.Message, e);
 477                         }
 478
 479                         string typename =
 480                                 GetTypeFileName (basefile.SelectSingleNode("Type/@FullName").InnerText);
 481                         TypeDefinition type = assembly.GetType(typename);
 482                         if (type == null) {
 483                                 Warning ("Type no longer in assembly: " + typename);
 484                                 continue;
 485                         }
 486
 487                         seenTypes[type] = seenTypes;
 488                         DoUpdateType2("Updating", basefile, type, Path.Combine(outpath, file.Name), false);
 489                 }
 490
 491                 // Stub types not in the directory
 492                 foreach (TypeDefinition type in docEnum.GetDocumentationTypes (assembly, null)) {
 493                         if (type.Namespace != ns || seenTypes.ContainsKey(type))
 494                                 continue;
 495
 496                         XmlElement td = StubType(type, Path.Combine(outpath, GetTypeFileName(type) + ".xml"));
 497                         if (td == null) continue;
 498                 }
 499         }
 500
 501         private static string GetTypeFileName (TypeReference type)
 502         {
 503                 return filenameFormatter.GetName (type);
 504         }
 505
 506         public static string GetTypeFileName (string typename)
 507         {
 508                 StringBuilder filename = new StringBuilder (typename.Length);
 509                 int numArgs = 0;
 510                 int numLt = 0;
 511                 bool copy = true;
 512                 for (int i = 0; i < typename.Length; ++i) {
 513                         char c = typename [i];
 514                         switch (c) {
 515                                 case '<':
 516                                         copy = false;
 517                                         ++numLt;
 518                                         break;
 519                                 case '>':
 520                                         --numLt;
 521                                         if (numLt == 0) {
 522                                                 filename.Append ('`').Append ((numArgs+1).ToString());
 523                                                 numArgs = 0;
 524                                                 copy = true;
 525                                         }
 526                                         break;
 527                                 case ',':
 528                                         if (numLt == 1)
 529                                                 ++numArgs;
 530                                         break;
 531                                 default:
 532                                         if (copy)
 533                                                 filename.Append (c);
 534                                         break;
 535                         }
 536                 }
 537                 return filename.ToString ();
 538         }
 539
 540         private void AddIndexAssembly (AssemblyDefinition assembly, XmlElement parent)
 541         {
 542                 XmlElement index_assembly = parent.OwnerDocument.CreateElement("Assembly");
 543                 index_assembly.SetAttribute ("Name", assembly.Name.Name);
 544                 index_assembly.SetAttribute ("Version", assembly.Name.Version.ToString());
 545
 546                 AssemblyNameDefinition name = assembly.Name;
 547                 if (name.HasPublicKey) {
 548                         XmlElement pubkey = parent.OwnerDocument.CreateElement ("AssemblyPublicKey");
 549                         var key = new StringBuilder (name.PublicKey.Length*3 + 2);
 550                         key.Append ("[");
 551                         foreach (byte b in name.PublicKey)
 552                                 key.AppendFormat ("{0,2:x2} ", b);
 553                         key.Append ("]");
 554                         pubkey.InnerText = key.ToString ();
 555                         index_assembly.AppendChild (pubkey);
 556                 }
 557
 558                 if (!string.IsNullOrEmpty (name.Culture)) {
 559                         XmlElement culture = parent.OwnerDocument.CreateElement ("AssemblyCulture");
 560                         culture.InnerText = name.Culture;
 561                         index_assembly.AppendChild (culture);
 562                 }
 563
 564                 MakeAttributes (index_assembly, GetCustomAttributes (assembly.CustomAttributes, ""));
 565                 parent.AppendChild(index_assembly);
 566         }
 567
 568         private void AddIndexType (TypeDefinition type, XmlElement index_types)
 569         {
 570                 string typename = GetTypeFileName(type);
 571
 572                 // Add namespace and type nodes into the index file as needed
 573                 string ns = DocUtils.GetNamespace (type);
 574                 XmlElement nsnode = (XmlElement) index_types.SelectSingleNode ("Namespace[@Name='" + ns + "']");
 575                 if (nsnode == null) {
 576                         nsnode = index_types.OwnerDocument.CreateElement("Namespace");
 577                         nsnode.SetAttribute ("Name", ns);
 578                         index_types.AppendChild (nsnode);
 579                 }
 580                 string doc_typename = GetDocTypeName (type);
 581                 XmlElement typenode = (XmlElement) nsnode.SelectSingleNode ("Type[@Name='" + typename + "']");
 582                 if (typenode == null) {
 583                         typenode = index_types.OwnerDocument.CreateElement ("Type");
 584                         typenode.SetAttribute ("Name", typename);
 585                         nsnode.AppendChild (typenode);
 586                 }
 587                 if (typename != doc_typename)
 588                         typenode.SetAttribute("DisplayName", doc_typename);
 589                 else
 590                         typenode.RemoveAttribute("DisplayName");
 591
 592                 typenode.SetAttribute ("Kind", GetTypeKind (type));
 593         }
 594
 595         private void DoUpdateAssemblies (string source, string dest)
 596         {
 597                 string indexfile = dest + "/index.xml";
 598                 XmlDocument index;
 599                 if (System.IO.File.Exists(indexfile)) {
 600                         index = new XmlDocument();
 601                         index.Load(indexfile);
 602
 603                         // Format change
 604                         ClearElement(index.DocumentElement, "Assembly");
 605                         ClearElement(index.DocumentElement, "Attributes");
 606                 } else {
 607                         index = CreateIndexStub();
 608                 }
 609
 610                 string defaultTitle = "Untitled";
 611                 if (assemblies.Count == 1)
 612                         defaultTitle = assemblies[0].Name.Name;
 613                 WriteElementInitialText(index.DocumentElement, "Title", defaultTitle);
 614
 615                 XmlElement index_types = WriteElement(index.DocumentElement, "Types");
 616                 XmlElement index_assemblies = WriteElement(index.DocumentElement, "Assemblies");
 617                 index_assemblies.RemoveAll ();
 618
 619
 620                 HashSet<string> goodfiles = new HashSet<string> ();
 621
 622                 foreach (AssemblyDefinition assm in assemblies) {
 623                         AddIndexAssembly (assm, index_assemblies);
 624                         DoUpdateAssembly (assm, index_types, source, dest, goodfiles);
 625                 }
 626
 627                 SortIndexEntries (index_types);
 628
 629                 CleanupFiles (dest, goodfiles);
 630                 CleanupIndexTypes (index_types, goodfiles);
 631                 CleanupExtensions (index_types);
 632
 633                 WriteFile (indexfile, FileMode.Create,
 634                                 writer => WriteXml(index.DocumentElement, writer));
 635         }
 636
 637         private static char[] InvalidFilenameChars = {'\\', '/', ':', '*', '?', '"', '<', '>', '|'};
 638
 639         private void DoUpdateAssembly (AssemblyDefinition assembly, XmlElement index_types, string source, string dest, HashSet<string> goodfiles)
 640         {
 641                 foreach (TypeDefinition type in docEnum.GetDocumentationTypes (assembly, null)) {
 642                         string typename = GetTypeFileName(type);
 643                         if (!IsPublic (type) || typename.IndexOfAny (InvalidFilenameChars) >= 0)
 644                                 continue;
 645
 646                         string reltypepath = DoUpdateType (type, source, dest);
 647                         if (reltypepath == null)
 648                                 continue;
 649
 650                         // Add namespace and type nodes into the index file as needed
 651                         AddIndexType (type, index_types);
 652
 653                         // Ensure the namespace index file exists
 654                         string onsdoc = DocUtils.PathCombine (dest, type.Namespace + ".xml");
 655                         string nsdoc  = DocUtils.PathCombine (dest, "ns-" + type.Namespace + ".xml");
 656                         if (File.Exists (onsdoc)) {
 657                                 File.Move (onsdoc, nsdoc);
 658                         }
 659
 660                         if (!File.Exists (nsdoc)) {
 661                                 Console.WriteLine("New Namespace File: " + type.Namespace);
 662                                 WriteNamespaceStub(type.Namespace, dest);
 663                         }
 664
 665                         goodfiles.Add (reltypepath);
 666                 }
 667         }
 668
 669         private static void SortIndexEntries (XmlElement indexTypes)
 670         {
 671                 XmlNodeList namespaces = indexTypes.SelectNodes ("Namespace");
 672                 XmlNodeComparer c = new AttributeNameComparer ();
 673                 SortXmlNodes (indexTypes, namespaces, c);
 674
 675                 for (int i = 0; i < namespaces.Count; ++i)
 676                         SortXmlNodes (namespaces [i], namespaces [i].SelectNodes ("Type"), c);
 677         }
 678
 679         private static void SortXmlNodes (XmlNode parent, XmlNodeList children, XmlNodeComparer comparer)
 680         {
 681                 MyXmlNodeList l = new MyXmlNodeList (children.Count);
 682                 for (int i = 0; i < children.Count; ++i)
 683                         l.Add (children [i]);
 684                 l.Sort (comparer);
 685                 for (int i = l.Count - 1; i > 0; --i) {
 686                         parent.InsertBefore (parent.RemoveChild ((XmlNode) l [i-1]), (XmlNode) l [i]);
 687                 }
 688         }
 689
 690         abstract class XmlNodeComparer : IComparer, IComparer<XmlNode>
 691         {
 692                 public abstract int Compare (XmlNode x, XmlNode y);
 693
 694                 public int Compare (object x, object y)
 695                 {
 696                         return Compare ((XmlNode) x, (XmlNode) y);
 697                 }
 698         }
 699
 700         class AttributeNameComparer : XmlNodeComparer {
 701                 string attribute;
 702
 703                 public AttributeNameComparer ()
 704                         : this ("Name")
 705                 {
 706                 }
 707
 708                 public AttributeNameComparer (string attribute)
 709                 {
 710                         this.attribute = attribute;
 711                 }
 712
 713                 public override int Compare (XmlNode x, XmlNode y)
 714                 {
 715                         return x.Attributes [attribute].Value.CompareTo (y.Attributes [attribute].Value);
 716                 }
 717         }
 718
 719         class VersionComparer : XmlNodeComparer {
 720                 public override int Compare (XmlNode x, XmlNode y)
 721                 {
 722                         // Some of the existing docs use e.g. 1.0.x.x, which Version doesn't like.
 723                         string a = GetVersion (x.InnerText);
 724                         string b = GetVersion (y.InnerText);
 725                         return new Version (a).CompareTo (new Version (b));
 726                 }
 727
 728                 static string GetVersion (string v)
 729                 {
 730                         int n = v.IndexOf ("x");
 731                         if (n < 0)
 732                                 return v;
 733                         return v.Substring (0, n-1);
 734                 }
 735         }
 736
 737         private static string GetTypeKind (TypeDefinition type)
 738         {
 739                 if (type.IsEnum)
 740                         return "Enumeration";
 741                 if (type.IsValueType)
 742                         return "Structure";
 743                 if (type.IsInterface)
 744                         return "Interface";
 745                 if (DocUtils.IsDelegate (type))
 746                         return "Delegate";
 747                 if (type.IsClass || type.FullName == "System.Enum") // FIXME
 748                         return "Class";
 749                 throw new ArgumentException ("Unknown kind for type: " + type.FullName);
 750         }
 751
 752         private static bool IsPublic (TypeDefinition type)
 753         {
 754                 TypeDefinition decl = type;
 755                 while (decl != null) {
 756                         if (!(decl.IsPublic || decl.IsNestedPublic)) {
 757                                 return false;
 758                         }
 759                         decl = (TypeDefinition) decl.DeclaringType;
 760                 }
 761                 return true;
 762         }
 763
 764         private void CleanupFiles (string dest, HashSet<string> goodfiles)
 765         {
 766                 // Look for files that no longer correspond to types
 767                 foreach (System.IO.DirectoryInfo nsdir in new System.IO.DirectoryInfo(dest).GetDirectories("*")) {
 768                         foreach (System.IO.FileInfo typefile in nsdir.GetFiles("*.xml")) {
 769                                 string relTypeFile = Path.Combine(nsdir.Name, typefile.Name);
 770                                 if (!goodfiles.Contains (relTypeFile)) {
 771                                         XmlDocument doc = new XmlDocument ();
 772                                         doc.Load (typefile.FullName);
 773                                         XmlElement e = doc.SelectSingleNode("/Type") as XmlElement;
 774                                         if (UpdateAssemblyVersions(e, GetAssemblyVersions(), false)) {
 775                                                 using (TextWriter writer = OpenWrite (typefile.FullName, FileMode.Truncate))
 776                                                         WriteXml(doc.DocumentElement, writer);
 777                                                 goodfiles.Add (relTypeFile);
 778                                                 continue;
 779                                         }
 780                                         string newname = typefile.FullName + ".remove";
 781                                         try { System.IO.File.Delete(newname); } catch (Exception) { }
 782                                         try { typefile.MoveTo(newname); } catch (Exception) { }
 783                                         Console.WriteLine("Class no longer present; file renamed: " + Path.Combine(nsdir.Name, typefile.Name));
 784                                 }
 785                         }
 786                 }
 787         }
 788
 789         private static TextWriter OpenWrite (string path, FileMode mode)
 790         {
 791                 var w = new StreamWriter (
 792                         new FileStream (path, mode),
 793                         new UTF8Encoding (false)
 794                 );
 795                 w.NewLine = "\n";
 796                 return w;
 797         }
 798
 799         private string[] GetAssemblyVersions ()
 800         {
 801                 return (from a in assemblies select GetAssemblyVersion (a)).ToArray ();
 802         }
 803
 804         private static void CleanupIndexTypes (XmlElement index_types, HashSet<string> goodfiles)
 805         {
 806                 // Look for type nodes that no longer correspond to types
 807                 MyXmlNodeList remove = new MyXmlNodeList ();
 808                 foreach (XmlElement typenode in index_types.SelectNodes("Namespace/Type")) {
 809                         string fulltypename = Path.Combine (((XmlElement)typenode.ParentNode).GetAttribute("Name"), typenode.GetAttribute("Name") + ".xml");
 810                         if (!goodfiles.Contains (fulltypename)) {
 811                                 remove.Add (typenode);
 812                         }
 813                 }
 814                 foreach (XmlNode n in remove)
 815                         n.ParentNode.RemoveChild (n);
 816         }
 817
 818         private void CleanupExtensions (XmlElement index_types)
 819         {
 820                 XmlNode e = index_types.SelectSingleNode ("/Overview/ExtensionMethods");
 821                 if (extensionMethods.Count == 0) {
 822                         if (e == null)
 823                                 return;
 824                         index_types.SelectSingleNode ("/Overview").RemoveChild (e);
 825                         return;
 826                 }
 827                 if (e == null) {
 828                         e = index_types.OwnerDocument.CreateElement ("ExtensionMethods");
 829                         index_types.SelectSingleNode ("/Overview").AppendChild (e);
 830                 }
 831                 else
 832                         e.RemoveAll ();
 833                 extensionMethods.Sort (DefaultExtensionMethodComparer);
 834                 foreach (XmlNode m in extensionMethods) {
 835                         e.AppendChild (index_types.OwnerDocument.ImportNode (m, true));
 836                 }
 837         }
 838
 839         class ExtensionMethodComparer : XmlNodeComparer {
 840                 public override int Compare (XmlNode x, XmlNode y)
 841                 {
 842                         XmlNode xLink = x.SelectSingleNode ("Member/Link");
 843                         XmlNode yLink = y.SelectSingleNode ("Member/Link");
 844
 845                         int n = xLink.Attributes ["Type"].Value.CompareTo (
 846                                         yLink.Attributes ["Type"].Value);
 847                         if (n != 0)
 848                                 return n;
 849                         n = xLink.Attributes ["Member"].Value.CompareTo (
 850                                         yLink.Attributes ["Member"].Value);
 851                         if (n == 0 && !object.ReferenceEquals (x, y))
 852                                 throw new InvalidOperationException ("Duplicate extension method found!");
 853                         return n;
 854                 }
 855         }
 856
 857         static readonly XmlNodeComparer DefaultExtensionMethodComparer = new ExtensionMethodComparer ();
 858
 859         public void DoUpdateType2 (string message, XmlDocument basefile, TypeDefinition type, string output, bool insertSince)
 860         {
 861                 Console.WriteLine(message + ": " + type.FullName);
 862
 863                 StringToXmlNodeMap seenmembers = new StringToXmlNodeMap ();
 864
 865                 // Update type metadata
 866                 UpdateType(basefile.DocumentElement, type);
 867
 868                 // Update existing members.  Delete member nodes that no longer should be there,
 869                 // and remember what members are already documented so we don't add them again.
 870                 if (true) {
 871                         MyXmlNodeList todelete = new MyXmlNodeList ();
 872                         foreach (DocsNodeInfo info in docEnum.GetDocumentationMembers (basefile, type)) {
 873                                 XmlElement oldmember  = info.Node;
 874                                 MemberReference oldmember2 = info.Member;
 875                                 string sig = oldmember2 != null ? memberFormatters [0].GetDeclaration (oldmember2) : null;
 876
 877                                 // Interface implementations and overrides are deleted from the docs
 878                                 // unless the overrides option is given.
 879                                 if (oldmember2 != null && sig == null)
 880                                         oldmember2 = null;
 881
 882                                 // Deleted (or signature changed)
 883                                 if (oldmember2 == null) {
 884                                         if (UpdateAssemblyVersions (oldmember, new string[]{ GetAssemblyVersion (type.Module.Assembly) }, false))
 885                                                 continue;
 886                                         DeleteMember ("Member Removed", output, oldmember, todelete);
 887                                         continue;
 888                                 }
 889
 890                                 // Duplicated
 891                                 if (seenmembers.ContainsKey (sig)) {
 892                                         if (object.ReferenceEquals (oldmember, seenmembers [sig])) {
 893                                                 // ignore, already seen
 894                                         }
 895                                         else if (DefaultMemberComparer.Compare (oldmember, seenmembers [sig]) == 0)
 896                                                 DeleteMember ("Duplicate Member Found", output, oldmember, todelete);
 897                                         else
 898                                                 Warning ("TODO: found a duplicate member '{0}', but it's not identical to the prior member found!", sig);
 899                                         continue;
 900                                 }
 901
 902                                 // Update signature information
 903                                 UpdateMember(info);
 904
 905                                 seenmembers.Add (sig, oldmember);
 906                         }
 907                         foreach (XmlElement oldmember in todelete)
 908                                 oldmember.ParentNode.RemoveChild (oldmember);
 909                 }
 910
 911                 if (!DocUtils.IsDelegate (type)) {
 912                         XmlNode members = WriteElement (basefile.DocumentElement, "Members");
 913                         foreach (MemberReference m in type.GetMembers()) {
 914                                 if (m is TypeDefinition) continue;
 915
 916                                 string sig = memberFormatters [0].GetDeclaration (m);
 917                                 if (sig == null) continue;
 918                                 if (seenmembers.ContainsKey(sig)) continue;
 919
 920                                 XmlElement mm = MakeMember(basefile, new DocsNodeInfo (null, m));
 921                                 if (mm == null) continue;
 922                                 members.AppendChild( mm );
 923
 924                                 Console.WriteLine("Member Added: " + mm.SelectSingleNode("MemberSignature/@Value").InnerText);
 925                                 additions++;
 926                         }
 927                 }
 928
 929                 // Import code snippets from files
 930                 foreach (XmlNode code in basefile.GetElementsByTagName("code")) {
 931                         if (!(code is XmlElement)) continue;
 932                         string file = ((XmlElement)code).GetAttribute("src");
 933                         string lang = ((XmlElement)code).GetAttribute("lang");
 934                         if (file != "") {
 935                                 string src = GetCodeSource (lang, Path.Combine (srcPath, file));
 936                                 if (src != null)
 937                                         code.InnerText = src;
 938                         }
 939                 }
 940
 941                 if (insertSince && since != null) {
 942                         XmlNode docs = basefile.DocumentElement.SelectSingleNode("Docs");
 943                         docs.AppendChild (CreateSinceNode (basefile));
 944                 }
 945
 946                 do {
 947                         XmlElement d = basefile.DocumentElement ["Docs"];
 948                         XmlElement m = basefile.DocumentElement ["Members"];
 949                         if (d != null && m != null)
 950                                 basefile.DocumentElement.InsertBefore (
 951                                                 basefile.DocumentElement.RemoveChild (d), m);
 952                         SortTypeMembers (m);
 953                 } while (false);
 954
 955                 if (output == null)
 956                         WriteXml(basefile.DocumentElement, Console.Out);
 957                 else {
 958                         FileInfo file = new FileInfo (output);
 959                         if (!file.Directory.Exists) {
 960                                 Console.WriteLine("Namespace Directory Created: " + type.Namespace);
 961                                 file.Directory.Create ();
 962                         }
 963                         WriteFile (output, FileMode.Create,
 964                                         writer => WriteXml(basefile.DocumentElement, writer));
 965                 }
 966         }
 967
 968         private string GetCodeSource (string lang, string file)
 969         {
 970                 int anchorStart;
 971                 if (lang == "C#" && (anchorStart = file.IndexOf (".cs#")) >= 0) {
 972                         // Grab the specified region
 973                         string region = "#region " + file.Substring (anchorStart + 4);
 974                         file          = file.Substring (0, anchorStart + 3);
 975                         try {
 976                                 using (StreamReader reader = new StreamReader (file)) {
 977                                         string line;
 978                                         StringBuilder src = new StringBuilder ();
 979                                         int indent = -1;
 980                                         while ((line = reader.ReadLine ()) != null) {
 981                                                 if (line.Trim() == region) {
 982                                                         indent = line.IndexOf (region);
 983                                                         continue;
 984                                                 }
 985                                                 if (indent >= 0 && line.Trim().StartsWith ("#endregion")) {
 986                                                         break;
 987                                                 }
 988                                                 if (indent >= 0)
 989                                                         src.Append (
 990                                                                         (line.Length > 0 ? line.Substring (indent) : string.Empty) +
 991                                                                         "\n");
 992                                         }
 993                                         return src.ToString ();
 994                                 }
 995                         } catch (Exception e) {
 996                                 Warning ("Could not load <code/> file '{0}' region '{1}': {2}",
 997                                                 file, region, show_exceptions ? e.ToString () : e.Message);
 998                                 return null;
 999                         }
1000                 }
1001                 try {
1002                         using (StreamReader reader = new StreamReader (file))
1003                                 return reader.ReadToEnd ();
1004                 } catch (Exception e) {
1005                         Warning ("Could not load <code/> file '" + file + "': " + e.Message);
1006                 }
1007                 return null;
1008         }
1009
1010         void DeleteMember (string reason, string output, XmlNode member, MyXmlNodeList todelete)
1011         {
1012                 string format = output != null
1013                         ? "{0}: File='{1}'; Signature='{4}'"
1014                         : "{0}: XPath='/Type[@FullName=\"{2}\"]/Members/Member[@MemberName=\"{3}\"]'; Signature='{4}'";
1015                 Warning (format,
1016                                 reason,
1017                                 output,
1018                                 member.OwnerDocument.DocumentElement.GetAttribute ("FullName"),
1019                                 member.Attributes ["MemberName"].Value,
1020                                 member.SelectSingleNode ("MemberSignature[@Language='C#']/@Value").Value);
1021                 if (!delete && MemberDocsHaveUserContent (member)) {
1022                         Warning ("Member deletions must be enabled with the --delete option.");
1023                 } else {
1024                         todelete.Add (member);
1025                         deletions++;
1026                 }
1027         }
1028
1029         class MemberComparer : XmlNodeComparer {
1030                 public override int Compare (XmlNode x, XmlNode y)
1031                 {
1032                         int r;
1033                         string xMemberName = x.Attributes ["MemberName"].Value;
1034                         string yMemberName = y.Attributes ["MemberName"].Value;
1035
1036                         // generic methods *end* with '>'
1037                         // it's possible for explicitly implemented generic interfaces to
1038                         // contain <...> without being a generic method
1039                         if ((!xMemberName.EndsWith (">") || !yMemberName.EndsWith (">")) &&
1040                                         (r = xMemberName.CompareTo (yMemberName)) != 0)
1041                                 return r;
1042
1043                         int lt;
1044                         if ((lt = xMemberName.IndexOf ("<")) >= 0)
1045                                 xMemberName = xMemberName.Substring (0, lt);
1046                         if ((lt = yMemberName.IndexOf ("<")) >= 0)
1047                                 yMemberName = yMemberName.Substring (0, lt);
1048                         if ((r = xMemberName.CompareTo (yMemberName)) != 0)
1049                                 return r;
1050
1051                         // if @MemberName matches, then it's either two different types of
1052                         // members sharing the same name, e.g. field & property, or it's an
1053                         // overloaded method.
1054                         // for different type, sort based on MemberType value.
1055                         r = x.SelectSingleNode ("MemberType").InnerText.CompareTo (
1056                                         y.SelectSingleNode ("MemberType").InnerText);
1057                         if (r != 0)
1058                                 return r;
1059
1060                         // same type -- must be an overloaded method.  Sort based on type
1061                         // parameter count, then parameter count, then by the parameter
1062                         // type names.
1063                         XmlNodeList xTypeParams = x.SelectNodes ("TypeParameters/TypeParameter");
1064                         XmlNodeList yTypeParams = y.SelectNodes ("TypeParameters/TypeParameter");
1065                         if (xTypeParams.Count != yTypeParams.Count)
1066                                 return xTypeParams.Count <= yTypeParams.Count ? -1 : 1;
1067                         for (int i = 0; i < xTypeParams.Count; ++i) {
1068                                 r = xTypeParams [i].Attributes ["Name"].Value.CompareTo (
1069                                                 yTypeParams [i].Attributes ["Name"].Value);
1070                                 if (r != 0)
1071                                         return r;
1072                         }
1073
1074                         XmlNodeList xParams = x.SelectNodes ("Parameters/Parameter");
1075                         XmlNodeList yParams = y.SelectNodes ("Parameters/Parameter");
1076                         if (xParams.Count != yParams.Count)
1077                                 return xParams.Count <= yParams.Count ? -1 : 1;
1078                         for (int i = 0; i < xParams.Count; ++i) {
1079                                 r = xParams [i].Attributes ["Type"].Value.CompareTo (
1080                                                 yParams [i].Attributes ["Type"].Value);
1081                                 if (r != 0)
1082                                         return r;
1083                         }
1084                         // all parameters match, but return value might not match if it was
1085                         // changed between one version and another.
1086                         XmlNode xReturn = x.SelectSingleNode ("ReturnValue/ReturnType");
1087                         XmlNode yReturn = y.SelectSingleNode ("ReturnValue/ReturnType");
1088                         if (xReturn != null && yReturn != null) {
1089                                 r = xReturn.InnerText.CompareTo (yReturn.InnerText);
1090                                 if (r != 0)
1091                                         return r;
1092                         }
1093
1094                         return 0;
1095                 }
1096         }
1097
1098         static readonly MemberComparer DefaultMemberComparer = new MemberComparer ();
1099
1100         private static void SortTypeMembers (XmlNode members)
1101         {
1102                 if (members == null)
1103                         return;
1104                 SortXmlNodes (members, members.SelectNodes ("Member"), DefaultMemberComparer);
1105         }
1106
1107         private static bool MemberDocsHaveUserContent (XmlNode e)
1108         {
1109                 e = (XmlElement)e.SelectSingleNode("Docs");
1110                 if (e == null) return false;
1111                 foreach (XmlElement d in e.SelectNodes("*"))
1112                         if (d.InnerText != "" && !d.InnerText.StartsWith("To be added"))
1113                                 return true;
1114                 return false;
1115         }
1116
1117         // UPDATE HELPER FUNCTIONS
1118
1119         // CREATE A STUB DOCUMENTATION FILE
1120
1121         public XmlElement StubType (TypeDefinition type, string output)
1122         {
1123                 string typesig = typeFormatters [0].GetDeclaration (type);
1124                 if (typesig == null) return null; // not publicly visible
1125
1126                 XmlDocument doc = new XmlDocument();
1127                 XmlElement root = doc.CreateElement("Type");
1128                 doc.AppendChild (root);
1129
1130                 DoUpdateType2 ("New Type", doc, type, output, true);
1131
1132                 return root;
1133         }
1134
1135         private XmlElement CreateSinceNode (XmlDocument doc)
1136         {
1137                 XmlElement s = doc.CreateElement ("since");
1138                 s.SetAttribute ("version", since);
1139                 return s;
1140         }
1141
1142         // STUBBING/UPDATING FUNCTIONS
1143
1144         public void UpdateType (XmlElement root, TypeDefinition type)
1145         {
1146                 root.SetAttribute("Name", GetDocTypeName (type));
1147                 root.SetAttribute("FullName", GetDocTypeFullName (type));
1148
1149                 foreach (MemberFormatter f in typeFormatters) {
1150                         string element = "TypeSignature[@Language='" + f.Language + "']";
1151                         WriteElementAttribute (root, element, "Language", f.Language);
1152                         WriteElementAttribute (root, element, "Value", f.GetDeclaration (type));
1153                 }
1154
1155                 XmlElement ass = WriteElement(root, "AssemblyInfo");
1156                 WriteElementText(ass, "AssemblyName", type.Module.Assembly.Name.Name);
1157                 if (!no_assembly_versions) {
1158                         UpdateAssemblyVersions (root, type, true);
1159                 }
1160                 else {
1161                         var versions = ass.SelectNodes ("AssemblyVersion").Cast<XmlNode> ().ToList ();
1162                         foreach (var version in versions)
1163                                 ass.RemoveChild (version);
1164                 }
1165                 if (!string.IsNullOrEmpty (type.Module.Assembly.Name.Culture))
1166                         WriteElementText(ass, "AssemblyCulture", type.Module.Assembly.Name.Culture);
1167                 else
1168                         ClearElement(ass, "AssemblyCulture");
1169
1170                 // Why-oh-why do we put assembly attributes in each type file?
1171                 // Neither monodoc nor monodocs2html use them, so I'm deleting them
1172                 // since they're outdated in current docs, and a waste of space.
1173                 //MakeAttributes(ass, type.Assembly, true);
1174                 XmlNode assattrs = ass.SelectSingleNode("Attributes");
1175                 if (assattrs != null)
1176                         ass.RemoveChild(assattrs);
1177
1178                 NormalizeWhitespace(ass);
1179
1180                 if (type.IsGenericType ()) {
1181                         MakeTypeParameters (root, type.GenericParameters);
1182                 } else {
1183                         ClearElement(root, "TypeParameters");
1184                 }
1185
1186                 if (type.BaseType != null) {
1187                         XmlElement basenode = WriteElement(root, "Base");
1188
1189                         string basetypename = GetDocTypeFullName (type.BaseType);
1190                         if (basetypename == "System.MulticastDelegate") basetypename = "System.Delegate";
1191                         WriteElementText(root, "Base/BaseTypeName", basetypename);
1192
1193                         // Document how this type instantiates the generic parameters of its base type
1194                         TypeReference origBase = type.BaseType.GetElementType ();
1195                         if (origBase.IsGenericType ()) {
1196                                 ClearElement(basenode, "BaseTypeArguments");
1197                                 GenericInstanceType baseInst             = type.BaseType as GenericInstanceType;
1198                                 IList<TypeReference> baseGenArgs    = baseInst == null ? null : baseInst.GenericArguments;
1199                                 IList<GenericParameter> baseGenParams = origBase.GenericParameters;
1200                                 if (baseGenArgs.Count != baseGenParams.Count)
1201                                         throw new InvalidOperationException ("internal error: number of generic arguments doesn't match number of generic parameters.");
1202                                 for (int i = 0; baseGenArgs != null && i < baseGenArgs.Count; i++) {
1203                                         GenericParameter param = baseGenParams [i];
1204                                         TypeReference    value = baseGenArgs [i];
1205
1206                                         XmlElement bta = WriteElement(basenode, "BaseTypeArguments");
1207                                         XmlElement arg = bta.OwnerDocument.CreateElement("BaseTypeArgument");
1208                                         bta.AppendChild(arg);
1209                                         arg.SetAttribute ("TypeParamName", param.Name);
1210                                         arg.InnerText = GetDocTypeFullName (value);
1211                                 }
1212                         }
1213                 } else {
1214                         ClearElement(root, "Base");
1215                 }
1216
1217                 if (!DocUtils.IsDelegate (type) && !type.IsEnum) {
1218                         IEnumerable<TypeReference> userInterfaces = DocUtils.GetUserImplementedInterfaces (type);
1219                         List<string> interface_names = userInterfaces
1220                                         .Select (iface => GetDocTypeFullName (iface))
1221                                         .OrderBy (s => s)
1222                                         .ToList ();
1223
1224                         XmlElement interfaces = WriteElement(root, "Interfaces");
1225                         interfaces.RemoveAll();
1226                         foreach (string iname in interface_names) {
1227                                 XmlElement iface = root.OwnerDocument.CreateElement("Interface");
1228                                 interfaces.AppendChild(iface);
1229                                 WriteElementText(iface, "InterfaceName", iname);
1230                         }
1231                 } else {
1232                         ClearElement(root, "Interfaces");
1233                 }
1234
1235                 MakeAttributes (root, GetCustomAttributes (type));
1236
1237                 if (DocUtils.IsDelegate (type)) {
1238                         MakeTypeParameters (root, type.GenericParameters);
1239                         MakeParameters(root, type.GetMethod("Invoke").Parameters);
1240                         MakeReturnValue(root, type.GetMethod("Invoke"));
1241                 }
1242
1243                 DocsNodeInfo typeInfo = new DocsNodeInfo (WriteElement(root, "Docs"), type);
1244                 MakeDocNode (typeInfo);
1245
1246                 if (!DocUtils.IsDelegate (type))
1247                         WriteElement (root, "Members");
1248
1249                 OrderTypeNodes (root, root.ChildNodes);
1250                 NormalizeWhitespace(root);
1251         }
1252
1253         static readonly string[] TypeNodeOrder = {
1254                 "TypeSignature",
1255                 "MemberOfLibrary",
1256                 "AssemblyInfo",
1257                 "ThreadingSafetyStatement",
1258                 "ThreadSafetyStatement",
1259                 "TypeParameters",
1260                 "Base",
1261                 "Interfaces",
1262                 "Attributes",
1263                 "Parameters",
1264                 "ReturnValue",
1265                 "Docs",
1266                 "Members",
1267                 "TypeExcluded",
1268         };
1269
1270         static void OrderTypeNodes (XmlNode member, XmlNodeList children)
1271         {
1272                 ReorderNodes (member, children, TypeNodeOrder);
1273         }
1274
1275         internal static IEnumerable<T> Sort<T> (IEnumerable<T> list)
1276         {
1277                 List<T> l = new List<T> (list);
1278                 l.Sort ();
1279                 return l;
1280         }
1281
1282         private void UpdateMember (DocsNodeInfo info)
1283         {
1284                 XmlElement me = (XmlElement) info.Node;
1285                 MemberReference mi = info.Member;
1286
1287                 foreach (MemberFormatter f in memberFormatters) {
1288                         string element = "MemberSignature[@Language='" + f.Language + "']";
1289                         WriteElementAttribute (me, element, "Language", f.Language);
1290                         WriteElementAttribute (me, element, "Value", f.GetDeclaration (mi));
1291                 }
1292
1293                 WriteElementText(me, "MemberType", GetMemberType(mi));
1294
1295                 if (!no_assembly_versions) {
1296                         UpdateAssemblyVersions (me, mi, true);
1297                 }
1298                 else {
1299                         ClearElement (me, "AssemblyInfo");
1300                 }
1301
1302                 MakeAttributes (me, GetCustomAttributes (mi));
1303
1304                 MakeReturnValue(me, mi);
1305                 if (mi is MethodReference) {
1306                         MethodReference mb = (MethodReference) mi;
1307                         if (mb.IsGenericMethod ())
1308                                 MakeTypeParameters (me, mb.GenericParameters);
1309                 }
1310                 MakeParameters(me, mi);
1311
1312                 string fieldValue;
1313                 if (mi is FieldDefinition && GetFieldConstValue ((FieldDefinition)mi, out fieldValue))
1314                         WriteElementText(me, "MemberValue", fieldValue);
1315
1316                 info.Node = WriteElement (me, "Docs");
1317                 MakeDocNode (info);
1318                 OrderMemberNodes (me, me.ChildNodes);
1319                 UpdateExtensionMethods (me, info);
1320         }
1321
1322         static readonly string[] MemberNodeOrder = {
1323                 "MemberSignature",
1324                 "MemberType",
1325                 "AssemblyInfo",
1326                 "Attributes",
1327                 "ReturnValue",
1328                 "TypeParameters",
1329                 "Parameters",
1330                 "MemberValue",
1331                 "Docs",
1332                 "Excluded",
1333                 "ExcludedLibrary",
1334                 "Link",
1335         };
1336
1337         static void OrderMemberNodes (XmlNode member, XmlNodeList children)
1338         {
1339                 ReorderNodes (member, children, MemberNodeOrder);
1340         }
1341
1342         static void ReorderNodes (XmlNode node, XmlNodeList children, string[] ordering)
1343         {
1344                 MyXmlNodeList newChildren = new MyXmlNodeList (children.Count);
1345                 for (int i = 0; i < ordering.Length; ++i) {
1346                         for (int j = 0; j < children.Count; ++j) {
1347                                 XmlNode c = children [j];
1348                                 if (c.Name == ordering [i]) {
1349                                         newChildren.Add (c);
1350                                 }
1351                         }
1352                 }
1353                 if (newChildren.Count >= 0)
1354                         node.PrependChild ((XmlNode) newChildren [0]);
1355                 for (int i = 1; i < newChildren.Count; ++i) {
1356                         XmlNode prev = (XmlNode) newChildren [i-1];
1357                         XmlNode cur  = (XmlNode) newChildren [i];
1358                         node.RemoveChild (cur);
1359                         node.InsertAfter (cur, prev);
1360                 }
1361         }
1362
1363         IEnumerable<string> GetCustomAttributes (MemberReference mi)
1364         {
1365                 IEnumerable<string> attrs = Enumerable.Empty<string>();
1366
1367                 ICustomAttributeProvider p = mi as ICustomAttributeProvider;
1368                 if (p != null)
1369                         attrs = attrs.Concat (GetCustomAttributes (p.CustomAttributes, ""));
1370
1371                 PropertyDefinition pd = mi as PropertyDefinition;
1372                 if (pd != null) {
1373                         if (pd.GetMethod != null)
1374                                 attrs = attrs.Concat (GetCustomAttributes (pd.GetMethod.CustomAttributes, "get: "));
1375                         if (pd.SetMethod != null)
1376                                 attrs = attrs.Concat (GetCustomAttributes (pd.SetMethod.CustomAttributes, "set: "));
1377                 }
1378
1379                 EventDefinition ed = mi as EventDefinition;
1380                 if (ed != null) {
1381                         if (ed.AddMethod != null)
1382                                 attrs = attrs.Concat (GetCustomAttributes (ed.AddMethod.CustomAttributes, "add: "));
1383                         if (ed.RemoveMethod != null)
1384                                 attrs = attrs.Concat (GetCustomAttributes (ed.RemoveMethod.CustomAttributes, "remove: "));
1385                 }
1386
1387                 return attrs;
1388         }
1389
1390         IEnumerable<string> GetCustomAttributes (IList<CustomAttribute> attributes, string prefix)
1391         {
1392                 foreach (CustomAttribute attribute in attributes.OrderBy (ca => ca.AttributeType.FullName)) {
1393
1394                         TypeDefinition attrType = attribute.AttributeType as TypeDefinition;
1395                         if (attrType != null && !IsPublic (attrType))
1396                                 continue;
1397                         if (slashdocFormatter.GetName (attribute.AttributeType) == null)
1398                                 continue;
1399
1400                         if (Array.IndexOf (IgnorableAttributes, attribute.AttributeType.FullName) >= 0)
1401                                 continue;
1402
1403                         StringList fields = new StringList ();
1404
1405                         for (int i = 0; i < attribute.ConstructorArguments.Count; ++i) {
1406                                 CustomAttributeArgument argument = attribute.ConstructorArguments [i];
1407                                 fields.Add (MakeAttributesValueString (
1408                                                 argument.Value,
1409                                                 argument.Type));
1410                         }
1411                         var namedArgs =
1412                                 (from namedArg in attribute.Fields
1413                                  select new { Type=namedArg.Argument.Type, Name=namedArg.Name, Value=namedArg.Argument.Value })
1414                                 .Concat (
1415                                                 (from namedArg in attribute.Properties
1416                                                  select new { Type=namedArg.Argument.Type, Name=namedArg.Name, Value=namedArg.Argument.Value }))
1417                                 .OrderBy (v => v.Name);
1418                         foreach (var d in namedArgs)
1419                                 fields.Add (string.Format ("{0}={1}", d.Name,
1420                                                 MakeAttributesValueString (d.Value, d.Type)));
1421
1422                         string a2 = String.Join(", ", fields.ToArray ());
1423                         if (a2 != "") a2 = "(" + a2 + ")";
1424
1425                         string name = attribute.Constructor.DeclaringType.FullName;
1426                         if (name.EndsWith("Attribute")) name = name.Substring(0, name.Length-"Attribute".Length);
1427                         yield return prefix + name + a2;
1428                 }
1429         }
1430
1431         static readonly string[] ValidExtensionMembers = {
1432                 "Docs",
1433                 "MemberSignature",
1434                 "MemberType",
1435                 "Parameters",
1436                 "ReturnValue",
1437                 "TypeParameters",
1438         };
1439
1440         static readonly string[] ValidExtensionDocMembers = {
1441                 "param",
1442                 "summary",
1443                 "typeparam",
1444         };
1445
1446         private void UpdateExtensionMethods (XmlElement e, DocsNodeInfo info)
1447         {
1448                 MethodDefinition me = info.Member as MethodDefinition;
1449                 if (me == null)
1450                         return;
1451                 if (info.Parameters.Count < 1)
1452                         return;
1453                 if (!DocUtils.IsExtensionMethod (me))
1454                         return;
1455
1456                 XmlNode em = e.OwnerDocument.CreateElement ("ExtensionMethod");
1457                 XmlNode member = e.CloneNode (true);
1458                 em.AppendChild (member);
1459                 RemoveExcept (member, ValidExtensionMembers);
1460                 RemoveExcept (member.SelectSingleNode ("Docs"), ValidExtensionDocMembers);
1461                 WriteElementText (member, "MemberType", "ExtensionMethod");
1462                 XmlElement link = member.OwnerDocument.CreateElement ("Link");
1463                 link.SetAttribute ("Type", slashdocFormatter.GetName (me.DeclaringType));
1464                 link.SetAttribute ("Member", slashdocFormatter.GetDeclaration (me));
1465                 member.AppendChild (link);
1466                 AddTargets (em, info);
1467
1468                 extensionMethods.Add (em);
1469         }
1470
1471         private static void RemoveExcept (XmlNode node, string[] except)
1472         {
1473                 if (node == null)
1474                         return;
1475                 MyXmlNodeList remove = null;
1476                 foreach (XmlNode n in node.ChildNodes) {
1477                         if (Array.BinarySearch (except, n.Name) < 0) {
1478                                 if (remove == null)
1479                                         remove = new MyXmlNodeList ();
1480                                 remove.Add (n);
1481                         }
1482                 }
1483                 if (remove != null)
1484                         foreach (XmlNode n in remove)
1485                                 node.RemoveChild (n);
1486         }
1487
1488         private static void AddTargets (XmlNode member, DocsNodeInfo info)
1489         {
1490                 XmlElement targets = member.OwnerDocument.CreateElement ("Targets");
1491                 member.PrependChild (targets);
1492                 if (!(info.Parameters [0].ParameterType is GenericParameter)) {
1493                         AppendElementAttributeText (targets, "Target", "Type",
1494                                 slashdocFormatter.GetDeclaration (info.Parameters [0].ParameterType));
1495                 }
1496                 else {
1497                         GenericParameter gp = (GenericParameter) info.Parameters [0].ParameterType;
1498                         IList<TypeReference> constraints = gp.Constraints;
1499                         if (constraints.Count == 0)
1500                                 AppendElementAttributeText (targets, "Target", "Type", "System.Object");
1501                         else
1502                                 foreach (TypeReference c in constraints)
1503                                         AppendElementAttributeText(targets, "Target", "Type",
1504                                                 slashdocFormatter.GetDeclaration (c));
1505                 }
1506         }
1507
1508         private static bool GetFieldConstValue (FieldDefinition field, out string value)
1509         {
1510                 value = null;
1511                 TypeDefinition type = field.DeclaringType.Resolve ();
1512                 if (type != null && type.IsEnum) return false;
1513
1514                 if (type != null && type.IsGenericType ()) return false;
1515                 if (!field.HasConstant)
1516                         return false;
1517                 if (field.IsLiteral) {
1518                         object val = field.Constant;
1519                         if (val == null) value = "null";
1520                         else if (val is Enum) value = val.ToString();
1521                         else if (val is IFormattable) {
1522                                 value = ((IFormattable)val).ToString();
1523                                 if (val is string)
1524                                         value = "\"" + value + "\"";
1525                         }
1526                         if (value != null && value != "")
1527                                 return true;
1528                 }
1529                 return false;
1530         }
1531
1532         // XML HELPER FUNCTIONS
1533
1534         internal static XmlElement WriteElement(XmlNode parent, string element) {
1535                 XmlElement ret = (XmlElement)parent.SelectSingleNode(element);
1536                 if (ret == null) {
1537                         string[] path = element.Split('/');
1538                         foreach (string p in path) {
1539                                 ret = (XmlElement)parent.SelectSingleNode(p);
1540                                 if (ret == null) {
1541                                         string ename = p;
1542                                         if (ename.IndexOf('[') >= 0) // strip off XPath predicate
1543                                                 ename = ename.Substring(0, ename.IndexOf('['));
1544                                         ret = parent.OwnerDocument.CreateElement(ename);
1545                                         parent.AppendChild(ret);
1546                                         parent = ret;
1547                                 } else {
1548                                         parent = ret;
1549                                 }
1550                         }
1551                 }
1552                 return ret;
1553         }
1554         private static void WriteElementText(XmlNode parent, string element, string value) {
1555                 XmlElement node = WriteElement(parent, element);
1556                 node.InnerText = value;
1557         }
1558
1559         static XmlElement AppendElementText (XmlNode parent, string element, string value)
1560         {
1561                 XmlElement n = parent.OwnerDocument.CreateElement (element);
1562                 parent.AppendChild (n);
1563                 n.InnerText = value;
1564                 return n;
1565         }
1566
1567         static XmlElement AppendElementAttributeText (XmlNode parent, string element, string attribute, string value)
1568         {
1569                 XmlElement n = parent.OwnerDocument.CreateElement (element);
1570                 parent.AppendChild (n);
1571                 n.SetAttribute (attribute, value);
1572                 return n;
1573         }
1574
1575         internal static XmlNode CopyNode (XmlNode source, XmlNode dest)
1576         {
1577                 XmlNode copy = dest.OwnerDocument.ImportNode (source, true);
1578                 dest.AppendChild (copy);
1579                 return copy;
1580         }
1581
1582         private static void WriteElementInitialText(XmlElement parent, string element, string value) {
1583                 XmlElement node = (XmlElement)parent.SelectSingleNode(element);
1584                 if (node != null)
1585                         return;
1586                 node = WriteElement(parent, element);
1587                 node.InnerText = value;
1588         }
1589         private static void WriteElementAttribute(XmlElement parent, string element, string attribute, string value) {
1590                 XmlElement node = WriteElement(parent, element);
1591                 if (node.GetAttribute(attribute) == value) return;
1592                 node.SetAttribute(attribute, value);
1593         }
1594         internal static void ClearElement(XmlElement parent, string name) {
1595                 XmlElement node = (XmlElement)parent.SelectSingleNode(name);
1596                 if (node != null)
1597                         parent.RemoveChild(node);
1598         }
1599
1600         // DOCUMENTATION HELPER FUNCTIONS
1601
1602         private void MakeDocNode (DocsNodeInfo info)
1603         {
1604                 List<GenericParameter> genericParams      = info.GenericParameters;
1605                 IList<ParameterDefinition> parameters  = info.Parameters;
1606                 TypeReference returntype                  = info.ReturnType;
1607                 bool returnisreturn         = info.ReturnIsReturn;
1608                 XmlElement e                = info.Node;
1609                 bool addremarks             = info.AddRemarks;
1610
1611                 WriteElementInitialText(e, "summary", "To be added.");
1612
1613                 if (parameters != null) {
1614                         string[] values = new string [parameters.Count];
1615                         for (int i = 0; i < values.Length; ++i)
1616                                 values [i] = parameters [i].Name;
1617                         UpdateParameters (e, "param", values);
1618                 }
1619
1620                 if (genericParams != null) {
1621                         string[] values = new string [genericParams.Count];
1622                         for (int i = 0; i < values.Length; ++i)
1623                                 values [i] = genericParams [i].Name;
1624                         UpdateParameters (e, "typeparam", values);
1625                 }
1626
1627                 string retnodename = null;
1628                 if (returntype != null && returntype.FullName != "System.Void") { // FIXME
1629                         retnodename = returnisreturn ? "returns" : "value";
1630                         string retnodename_other = !returnisreturn ? "returns" : "value";
1631
1632                         // If it has a returns node instead of a value node, change its name.
1633                         XmlElement retother = (XmlElement)e.SelectSingleNode(retnodename_other);
1634                         if (retother != null) {
1635                                 XmlElement retnode = e.OwnerDocument.CreateElement(retnodename);
1636                                 foreach (XmlNode node in retother)
1637                                         retnode.AppendChild(node.CloneNode(true));
1638                                 e.ReplaceChild(retnode, retother);
1639                         } else {
1640                                 WriteElementInitialText(e, retnodename, "To be added.");
1641                         }
1642                 } else {
1643                         ClearElement(e, "returns");
1644                         ClearElement(e, "value");
1645                 }
1646
1647                 if (addremarks)
1648                         WriteElementInitialText(e, "remarks", "To be added.");
1649
1650                 if (exceptions.HasValue && info.Member != null &&
1651                                 (exceptions.Value & ExceptionLocations.AddedMembers) == 0) {
1652                         UpdateExceptions (e, info.Member);
1653                 }
1654
1655                 foreach (DocumentationImporter importer in importers)
1656                         importer.ImportDocumentation (info);
1657
1658                 OrderDocsNodes (e, e.ChildNodes);
1659                 NormalizeWhitespace(e);
1660         }
1661
1662         static readonly string[] DocsNodeOrder = {
1663                 "typeparam", "param", "summary", "returns", "value", "remarks",
1664         };
1665
1666         private static void OrderDocsNodes (XmlNode docs, XmlNodeList children)
1667         {
1668                 ReorderNodes (docs, children, DocsNodeOrder);
1669         }
1670
1671
1672         private void UpdateParameters (XmlElement e, string element, string[] values)
1673         {
1674                 if (values != null) {
1675                         XmlNode[] paramnodes = new XmlNode[values.Length];
1676
1677                         // Some documentation had param nodes with leading spaces.
1678                         foreach (XmlElement paramnode in e.SelectNodes(element)){
1679                                 paramnode.SetAttribute("name", paramnode.GetAttribute("name").Trim());
1680                         }
1681
1682                         // If a member has only one parameter, we can track changes to
1683                         // the name of the parameter easily.
1684                         if (values.Length == 1 && e.SelectNodes(element).Count == 1) {
1685                                 UpdateParameterName (e, (XmlElement) e.SelectSingleNode(element), values [0]);
1686                         }
1687
1688                         bool reinsert = false;
1689
1690                         // Pick out existing and still-valid param nodes, and
1691                         // create nodes for parameters not in the file.
1692                         Hashtable seenParams = new Hashtable();
1693                         for (int pi = 0; pi < values.Length; pi++) {
1694                                 string p = values [pi];
1695                                 seenParams[p] = pi;
1696
1697                                 paramnodes[pi] = e.SelectSingleNode(element + "[@name='" + p + "']");
1698                                 if (paramnodes[pi] != null) continue;
1699
1700                                 XmlElement pe = e.OwnerDocument.CreateElement(element);
1701                                 pe.SetAttribute("name", p);
1702                                 pe.InnerText = "To be added.";
1703                                 paramnodes[pi] = pe;
1704                                 reinsert = true;
1705                         }
1706
1707                         // Remove parameters that no longer exist and check all params are in the right order.
1708                         int idx = 0;
1709                         MyXmlNodeList todelete = new MyXmlNodeList ();
1710                         foreach (XmlElement paramnode in e.SelectNodes(element)) {
1711                                 string name = paramnode.GetAttribute("name");
1712                                 if (!seenParams.ContainsKey(name)) {
1713                                         if (!delete && !paramnode.InnerText.StartsWith("To be added")) {
1714                                                 Warning ("The following param node can only be deleted if the --delete option is given: ");
1715                                                 if (e.ParentNode == e.OwnerDocument.DocumentElement) {
1716                                                         // delegate type
1717                                                         Warning ("\tXPath=/Type[@FullName=\"{0}\"]/Docs/param[@name=\"{1}\"]",
1718                                                                         e.OwnerDocument.DocumentElement.GetAttribute ("FullName"),
1719                                                                         name);
1720                                                 }
1721                                                 else {
1722                                                         Warning ("\tXPath=/Type[@FullName=\"{0}\"]//Member[@MemberName=\"{1}\"]/Docs/param[@name=\"{2}\"]",
1723                                                                         e.OwnerDocument.DocumentElement.GetAttribute ("FullName"),
1724                                                                         e.ParentNode.Attributes ["MemberName"].Value,
1725                                                                         name);
1726                                                 }
1727                                                 Warning ("\tValue={0}", paramnode.OuterXml);
1728                                         } else {
1729                                                 todelete.Add (paramnode);
1730                                         }
1731                                         continue;
1732                                 }
1733
1734                                 if ((int)seenParams[name] != idx)
1735                                         reinsert = true;
1736
1737                                 idx++;
1738                         }
1739
1740                         foreach (XmlNode n in todelete) {
1741                                 n.ParentNode.RemoveChild (n);
1742                         }
1743
1744                         // Re-insert the parameter nodes at the top of the doc section.
1745                         if (reinsert)
1746                                 for (int pi = values.Length-1; pi >= 0; pi--)
1747                                         e.PrependChild(paramnodes[pi]);
1748                 } else {
1749                         // Clear all existing param nodes
1750                         foreach (XmlNode paramnode in e.SelectNodes(element)) {
1751                                 if (!delete && !paramnode.InnerText.StartsWith("To be added")) {
1752                                         Console.WriteLine("The following param node can only be deleted if the --delete option is given:");
1753                                         Console.WriteLine(paramnode.OuterXml);
1754                                 } else {
1755                                         paramnode.ParentNode.RemoveChild(paramnode);
1756                                 }
1757                         }
1758                 }
1759         }
1760
1761         private static void UpdateParameterName (XmlElement docs, XmlElement pe, string newName)
1762         {
1763                 string existingName = pe.GetAttribute ("name");
1764                 pe.SetAttribute ("name", newName);
1765                 if (existingName == newName)
1766                         return;
1767                 foreach (XmlElement paramref in docs.SelectNodes (".//paramref"))
1768                         if (paramref.GetAttribute ("name").Trim () == existingName)
1769                                 paramref.SetAttribute ("name", newName);
1770         }
1771
1772         class CrefComparer : XmlNodeComparer {
1773
1774                 public CrefComparer ()
1775                 {
1776                 }
1777
1778                 public override int Compare (XmlNode x, XmlNode y)
1779                 {
1780                         string xType = x.Attributes ["cref"].Value;
1781                         string yType = y.Attributes ["cref"].Value;
1782                         string xNamespace = GetNamespace (xType);
1783                         string yNamespace = GetNamespace (yType);
1784
1785                         int c = xNamespace.CompareTo (yNamespace);
1786                         if (c != 0)
1787                                 return c;
1788                         return xType.CompareTo (yType);
1789                 }
1790
1791                 static string GetNamespace (string type)
1792                 {
1793                         int n = type.LastIndexOf ('.');
1794                         if (n >= 0)
1795                                 return type.Substring (0, n);
1796                         return string.Empty;
1797                 }
1798         }
1799
1800         private void UpdateExceptions (XmlNode docs, MemberReference member)
1801         {
1802                 foreach (var source in new ExceptionLookup (exceptions.Value)[member]) {
1803                         string cref = slashdocFormatter.GetDeclaration (source.Exception);
1804                         var node = docs.SelectSingleNode ("exception[@cref='" + cref + "']");
1805                         if (node != null)
1806                                 continue;
1807                         XmlElement e = docs.OwnerDocument.CreateElement ("exception");
1808                         e.SetAttribute ("cref", cref);
1809                         e.InnerXml = "To be added; from: <see cref=\"" +
1810                                 string.Join ("\" />, <see cref=\"",
1811                                                 source.Sources.Select (m => slashdocFormatter.GetDeclaration (m))
1812                                                 .ToArray ()) +
1813                                 "\" />";
1814                         docs.AppendChild (e);
1815                 }
1816                 SortXmlNodes (docs, docs.SelectNodes ("exception"),
1817                                 new CrefComparer ());
1818         }
1819
1820         private static void NormalizeWhitespace(XmlElement e) {
1821                 // Remove all text and whitespace nodes from the element so it
1822                 // is outputted with nice indentation and no blank lines.
1823                 ArrayList deleteNodes = new ArrayList();
1824                 foreach (XmlNode n in e)
1825                         if (n is XmlText || n is XmlWhitespace || n is XmlSignificantWhitespace)
1826                                 deleteNodes.Add(n);
1827                 foreach (XmlNode n in deleteNodes)
1828                                 n.ParentNode.RemoveChild(n);
1829         }
1830
1831         private static bool UpdateAssemblyVersions (XmlElement root, MemberReference member, bool add)
1832         {
1833                 TypeDefinition type = member as TypeDefinition;
1834                 if (type == null)
1835                         type = member.DeclaringType as TypeDefinition;
1836                 return UpdateAssemblyVersions(root, new string[]{ GetAssemblyVersion (type.Module.Assembly) }, add);
1837         }
1838
1839         private static string GetAssemblyVersion (AssemblyDefinition assembly)
1840         {
1841                 return assembly.Name.Version.ToString();
1842         }
1843
1844         private static bool UpdateAssemblyVersions(XmlElement root, string[] assemblyVersions, bool add)
1845         {
1846                 XmlElement e = (XmlElement) root.SelectSingleNode ("AssemblyInfo");
1847                 if (e == null) {
1848                         e = root.OwnerDocument.CreateElement("AssemblyInfo");
1849                         root.AppendChild(e);
1850                 }
1851                 List<XmlNode> matches = e.SelectNodes ("AssemblyVersion").Cast<XmlNode>()
1852                         .Where(v => Array.IndexOf (assemblyVersions, v.InnerText) >= 0)
1853                         .ToList ();
1854                 // matches.Count > 0 && add: ignore -- already present
1855                 if (matches.Count > 0 && !add) {
1856                         foreach (XmlNode c in matches)
1857                                 e.RemoveChild (c);
1858                 }
1859                 else if (matches.Count == 0 && add) {
1860                         foreach (string sv in assemblyVersions) {
1861                                 XmlElement c = root.OwnerDocument.CreateElement("AssemblyVersion");
1862                                 c.InnerText = sv;
1863                                 e.AppendChild(c);
1864                         }
1865                 }
1866                 // matches.Count == 0 && !add: ignore -- already not present
1867
1868                 XmlNodeList avs = e.SelectNodes ("AssemblyVersion");
1869                 SortXmlNodes (e, avs, new VersionComparer ());
1870
1871                 return avs.Count != 0;
1872         }
1873
1874         // FIXME: get TypeReferences instead of string comparison?
1875         private static string[] IgnorableAttributes = {
1876                 // Security related attributes
1877                 "System.Reflection.AssemblyKeyFileAttribute",
1878                 "System.Reflection.AssemblyDelaySignAttribute",
1879                 // Present in @RefType
1880                 "System.Runtime.InteropServices.OutAttribute",
1881                 // For naming the indexer to use when not using indexers
1882                 "System.Reflection.DefaultMemberAttribute",
1883                 // for decimal constants
1884                 "System.Runtime.CompilerServices.DecimalConstantAttribute",
1885                 // compiler generated code
1886                 "System.Runtime.CompilerServices.CompilerGeneratedAttribute",
1887                 // more compiler generated code, e.g. iterator methods
1888                 "System.Diagnostics.DebuggerHiddenAttribute",
1889                 "System.Runtime.CompilerServices.FixedBufferAttribute",
1890                 "System.Runtime.CompilerServices.UnsafeValueTypeAttribute",
1891                 // extension methods
1892                 "System.Runtime.CompilerServices.ExtensionAttribute",
1893                 // Used to differentiate 'object' from C#4 'dynamic'
1894                 "System.Runtime.CompilerServices.DynamicAttribute",
1895         };
1896
1897         private void MakeAttributes (XmlElement root, IEnumerable<string> attributes)
1898         {
1899                 if (!attributes.Any ()) {
1900                         ClearElement (root, "Attributes");
1901                         return;
1902                 }
1903
1904                 XmlElement e = (XmlElement)root.SelectSingleNode("Attributes");
1905                 if (e != null)
1906                         e.RemoveAll();
1907                 else if (e == null)
1908                         e = root.OwnerDocument.CreateElement("Attributes");
1909
1910                 foreach (string attribute in attributes) {
1911                         XmlElement ae = root.OwnerDocument.CreateElement("Attribute");
1912                         e.AppendChild(ae);
1913
1914                         WriteElementText(ae, "AttributeName", attribute);
1915                 }
1916
1917                 if (e.ParentNode == null)
1918                         root.AppendChild(e);
1919
1920                 NormalizeWhitespace(e);
1921         }
1922
1923         private static string MakeAttributesValueString (object v, TypeReference valueType)
1924         {
1925                 if (v == null)
1926                         return "null";
1927                 if (valueType.FullName == "System.Type")
1928                         return "typeof(" + v.ToString () + ")";
1929                 if (valueType.FullName == "System.String")
1930                         return "\"" + v.ToString () + "\"";
1931                 if (v is Boolean)
1932                         return (bool)v ? "true" : "false";
1933                 TypeDefinition valueDef = valueType.Resolve ();
1934                 if (valueDef == null || !valueDef.IsEnum)
1935                         return v.ToString ();
1936                 string typename = GetDocTypeFullName (valueType);
1937                 var values = GetEnumerationValues (valueDef);
1938                 long c = ToInt64 (v);
1939                 if (values.ContainsKey (c))
1940                         return typename + "." + values [c];
1941                 if (valueDef.CustomAttributes.Any (ca => ca.AttributeType.FullName == "System.FlagsAttribute")) {
1942                         return string.Join (" | ",
1943                                         (from i in values.Keys
1944                                          where (c & i) != 0
1945                                          select typename + "." + values [i])
1946                                         .ToArray ());
1947                 }
1948                 return "(" + GetDocTypeFullName (valueType) + ") " + v.ToString ();
1949         }
1950
1951         private static Dictionary<long, string> GetEnumerationValues (TypeDefinition type)
1952         {
1953                 var values = new Dictionary<long, string> ();
1954                 foreach (var f in
1955                                 (from f in type.Fields
1956                                  where !(f.IsRuntimeSpecialName || f.IsSpecialName)
1957                                  select f)) {
1958                         values [ToInt64 (f.Constant)] = f.Name;
1959                 }
1960                 return values;
1961         }
1962
1963         static long ToInt64 (object value)
1964         {
1965                 if (value is ulong)
1966                         return (long) (ulong) value;
1967                 return Convert.ToInt64 (value);
1968         }
1969
1970         private void MakeParameters (XmlElement root, IList<ParameterDefinition> parameters)
1971         {
1972                 XmlElement e = WriteElement(root, "Parameters");
1973                 e.RemoveAll();
1974                 foreach (ParameterDefinition p in parameters) {
1975                         XmlElement pe = root.OwnerDocument.CreateElement("Parameter");
1976                         e.AppendChild(pe);
1977                         pe.SetAttribute("Name", p.Name);
1978                         pe.SetAttribute("Type", GetDocParameterType (p.ParameterType));
1979                         if (p.ParameterType is ByReferenceType) {
1980                                 if (p.IsOut) pe.SetAttribute("RefType", "out");
1981                                 else pe.SetAttribute("RefType", "ref");
1982                         }
1983                         MakeAttributes (pe, GetCustomAttributes (p.CustomAttributes, ""));
1984                 }
1985         }
1986
1987         private void MakeTypeParameters (XmlElement root, IList<GenericParameter> typeParams)
1988         {
1989                 if (typeParams == null || typeParams.Count == 0) {
1990                         XmlElement f = (XmlElement) root.SelectSingleNode ("TypeParameters");
1991                         if (f != null)
1992                                 root.RemoveChild (f);
1993                         return;
1994                 }
1995                 XmlElement e = WriteElement(root, "TypeParameters");
1996                 e.RemoveAll();
1997                 foreach (GenericParameter t in typeParams) {
1998                         XmlElement pe = root.OwnerDocument.CreateElement("TypeParameter");
1999                         e.AppendChild(pe);
2000                         pe.SetAttribute("Name", t.Name);
2001                         MakeAttributes (pe, GetCustomAttributes (t.CustomAttributes, ""));
2002                         XmlElement ce = (XmlElement) e.SelectSingleNode ("Constraints");
2003                         IList<TypeReference> constraints = t.Constraints;
2004                         GenericParameterAttributes attrs = t.Attributes;
2005                         if (attrs == GenericParameterAttributes.NonVariant && constraints.Count == 0) {
2006                                 if (ce != null)
2007                                         e.RemoveChild (ce);
2008                                 continue;
2009                         }
2010                         if (ce != null)
2011                                 ce.RemoveAll();
2012                         else {
2013                                 ce = root.OwnerDocument.CreateElement ("Constraints");
2014                         }
2015                         pe.AppendChild (ce);
2016                         if ((attrs & GenericParameterAttributes.Contravariant) != 0)
2017                                 AppendElementText (ce, "ParameterAttribute", "Contravariant");
2018                         if ((attrs & GenericParameterAttributes.Covariant) != 0)
2019                                 AppendElementText (ce, "ParameterAttribute", "Covariant");
2020                         if ((attrs & GenericParameterAttributes.DefaultConstructorConstraint) != 0)
2021                                 AppendElementText (ce, "ParameterAttribute", "DefaultConstructorConstraint");
2022                         if ((attrs & GenericParameterAttributes.NotNullableValueTypeConstraint) != 0)
2023                                 AppendElementText (ce, "ParameterAttribute", "NotNullableValueTypeConstraint");
2024                         if ((attrs & GenericParameterAttributes.ReferenceTypeConstraint) != 0)
2025                                 AppendElementText (ce, "ParameterAttribute", "ReferenceTypeConstraint");
2026                         foreach (TypeReference c in constraints) {
2027                                 TypeDefinition cd = c.Resolve ();
2028                                 AppendElementText (ce,
2029                                                 (cd != null && cd.IsInterface) ? "InterfaceName" : "BaseTypeName",
2030                                                 GetDocTypeFullName (c));
2031                         }
2032                 }
2033         }
2034
2035         private void MakeParameters (XmlElement root, MemberReference mi)
2036         {
2037                 if (mi is MethodDefinition && ((MethodDefinition) mi).IsConstructor)
2038                         MakeParameters (root, ((MethodDefinition)mi).Parameters);
2039                 else if (mi is MethodDefinition) {
2040                         MethodDefinition mb = (MethodDefinition) mi;
2041                         IList<ParameterDefinition> parameters = mb.Parameters;
2042                         MakeParameters(root, parameters);
2043                         if (parameters.Count > 0 && DocUtils.IsExtensionMethod (mb)) {
2044                                 XmlElement p = (XmlElement) root.SelectSingleNode ("Parameters/Parameter[position()=1]");
2045                                 p.SetAttribute ("RefType", "this");
2046                         }
2047                 }
2048                 else if (mi is PropertyDefinition) {
2049                         IList<ParameterDefinition> parameters = ((PropertyDefinition)mi).Parameters;
2050                         if (parameters.Count > 0)
2051                                 MakeParameters(root, parameters);
2052                         else
2053                                 return;
2054                 }
2055                 else if (mi is FieldDefinition) return;
2056                 else if (mi is EventDefinition) return;
2057                 else throw new ArgumentException();
2058         }
2059
2060         internal static string GetDocParameterType (TypeReference type)
2061         {
2062                 return GetDocTypeFullName (type).Replace ("@", "&");
2063         }
2064
2065         private void MakeReturnValue (XmlElement root, TypeReference type, IList<CustomAttribute> attributes)
2066         {
2067                 XmlElement e = WriteElement(root, "ReturnValue");
2068                 e.RemoveAll();
2069                 WriteElementText(e, "ReturnType", GetDocTypeFullName (type));
2070                 if (attributes != null)
2071                         MakeAttributes(e, GetCustomAttributes (attributes, ""));
2072         }
2073
2074         private void MakeReturnValue (XmlElement root, MemberReference mi)
2075         {
2076                 if (mi is MethodDefinition && ((MethodDefinition) mi).IsConstructor)
2077                         return;
2078                 else if (mi is MethodDefinition)
2079                         MakeReturnValue (root, ((MethodDefinition)mi).ReturnType, ((MethodDefinition)mi).MethodReturnType.CustomAttributes);
2080                 else if (mi is PropertyDefinition)
2081                         MakeReturnValue (root, ((PropertyDefinition)mi).PropertyType, null);
2082                 else if (mi is FieldDefinition)
2083                         MakeReturnValue (root, ((FieldDefinition)mi).FieldType, null);
2084                 else if (mi is EventDefinition)
2085                         MakeReturnValue (root, ((EventDefinition)mi).EventType, null);
2086                 else
2087                         throw new ArgumentException(mi + " is a " + mi.GetType().FullName);
2088         }
2089
2090         private XmlElement MakeMember(XmlDocument doc, DocsNodeInfo info)
2091         {
2092                 MemberReference mi = info.Member;
2093                 if (mi is TypeDefinition) return null;
2094
2095                 string sigs = memberFormatters [0].GetDeclaration (mi);
2096                 if (sigs == null) return null; // not publicly visible
2097
2098                 // no documentation for property/event accessors.  Is there a better way of doing this?
2099                 if (mi.Name.StartsWith("get_")) return null;
2100                 if (mi.Name.StartsWith("set_")) return null;
2101                 if (mi.Name.StartsWith("add_")) return null;
2102                 if (mi.Name.StartsWith("remove_")) return null;
2103                 if (mi.Name.StartsWith("raise_")) return null;
2104
2105                 XmlElement me = doc.CreateElement("Member");
2106                 me.SetAttribute("MemberName", GetMemberName (mi));
2107
2108                 info.Node = me;
2109                 UpdateMember(info);
2110                 if (exceptions.HasValue &&
2111                                 (exceptions.Value & ExceptionLocations.AddedMembers) != 0)
2112                         UpdateExceptions (info.Node, info.Member);
2113
2114                 if (since != null) {
2115                         XmlNode docs = me.SelectSingleNode("Docs");
2116                         docs.AppendChild (CreateSinceNode (doc));
2117                 }
2118
2119                 return me;
2120         }
2121
2122         internal static string GetMemberName (MemberReference mi)
2123         {
2124                 MethodDefinition mb = mi as MethodDefinition;
2125                 if (mb == null) {
2126                         PropertyDefinition pi = mi as PropertyDefinition;
2127                         if (pi == null)
2128                                 return mi.Name;
2129                         return DocUtils.GetPropertyName (pi);
2130                 }
2131                 StringBuilder sb = new StringBuilder (mi.Name.Length);
2132                 if (!DocUtils.IsExplicitlyImplemented (mb))
2133                         sb.Append (mi.Name);
2134                 else {
2135                         TypeReference iface;
2136                         MethodReference ifaceMethod;
2137                         DocUtils.GetInfoForExplicitlyImplementedMethod (mb, out iface, out ifaceMethod);
2138                         sb.Append (GetDocTypeFullName (iface));
2139                         sb.Append ('.');
2140                         sb.Append (ifaceMethod.Name);
2141                 }
2142                 if (mb.IsGenericMethod ()) {
2143                         IList<GenericParameter> typeParams = mb.GenericParameters;
2144                         if (typeParams.Count > 0) {
2145                                 sb.Append ("<");
2146                                 sb.Append (typeParams [0].Name);
2147                                 for (int i = 1; i < typeParams.Count; ++i)
2148                                         sb.Append (",").Append (typeParams [i].Name);
2149                                 sb.Append (">");
2150                         }
2151                 }
2152                 return sb.ToString ();
2153         }
2154
2155         /// SIGNATURE GENERATION FUNCTIONS
2156         internal static bool IsPrivate (MemberReference mi)
2157         {
2158                 return memberFormatters [0].GetDeclaration (mi) == null;
2159         }
2160
2161         internal static string GetMemberType (MemberReference mi)
2162         {
2163                 if (mi is MethodDefinition && ((MethodDefinition) mi).IsConstructor)
2164                         return "Constructor";
2165                 if (mi is MethodDefinition)
2166                         return "Method";
2167                 if (mi is PropertyDefinition)
2168                         return "Property";
2169                 if (mi is FieldDefinition)
2170                         return "Field";
2171                 if (mi is EventDefinition)
2172                         return "Event";
2173                 throw new ArgumentException();
2174         }
2175
2176         private static string GetDocTypeName (TypeReference type)
2177         {
2178                 return docTypeFormatter.GetName (type);
2179         }
2180
2181         internal static string GetDocTypeFullName (TypeReference type)
2182         {
2183                 return DocTypeFullMemberFormatter.Default.GetName (type);
2184         }
2185
2186         internal static string GetXPathForMember (DocumentationMember member)
2187         {
2188                 StringBuilder xpath = new StringBuilder ();
2189                 xpath.Append ("//Members/Member[@MemberName=\"")
2190                         .Append (member.MemberName)
2191                         .Append ("\"]");
2192                 if (member.Parameters != null && member.Parameters.Count > 0) {
2193                         xpath.Append ("/Parameters[count(Parameter) = ")
2194                                 .Append (member.Parameters.Count);
2195                         for (int i = 0; i < member.Parameters.Count; ++i) {
2196                                 xpath.Append (" and Parameter [").Append (i+1).Append ("]/@Type=\"");
2197                                 xpath.Append (member.Parameters [i]);
2198                                 xpath.Append ("\"");
2199                         }
2200                         xpath.Append ("]/..");
2201                 }
2202                 return xpath.ToString ();
2203         }
2204
2205         public static string GetXPathForMember (XPathNavigator member)
2206         {
2207                 StringBuilder xpath = new StringBuilder ();
2208                 xpath.Append ("//Type[@FullName=\"")
2209                         .Append (member.SelectSingleNode ("../../@FullName").Value)
2210                         .Append ("\"]/");
2211                 xpath.Append ("Members/Member[@MemberName=\"")
2212                         .Append (member.SelectSingleNode ("@MemberName").Value)
2213                         .Append ("\"]");
2214                 XPathNodeIterator parameters = member.Select ("Parameters/Parameter");
2215                 if (parameters.Count > 0) {
2216                         xpath.Append ("/Parameters[count(Parameter) = ")
2217                                 .Append (parameters.Count);
2218                         int i = 0;
2219                         while (parameters.MoveNext ()) {
2220                                 ++i;
2221                                 xpath.Append (" and Parameter [").Append (i).Append ("]/@Type=\"");
2222                                 xpath.Append (parameters.Current.Value);
2223                                 xpath.Append ("\"");
2224                         }
2225                         xpath.Append ("]/..");
2226                 }
2227                 return xpath.ToString ();
2228         }
2229
2230         public static string GetXPathForMember (MemberReference member)
2231         {
2232                 StringBuilder xpath = new StringBuilder ();
2233                 xpath.Append ("//Type[@FullName=\"")
2234                         .Append (member.DeclaringType.FullName)
2235                         .Append ("\"]/");
2236                 xpath.Append ("Members/Member[@MemberName=\"")
2237                         .Append (GetMemberName (member))
2238                         .Append ("\"]");
2239
2240                 IList<ParameterDefinition> parameters = null;
2241                 if (member is MethodDefinition)
2242                         parameters = ((MethodDefinition) member).Parameters;
2243                 else if (member is PropertyDefinition) {
2244                         parameters = ((PropertyDefinition) member).Parameters;
2245                 }
2246                 if (parameters != null && parameters.Count > 0) {
2247                         xpath.Append ("/Parameters[count(Parameter) = ")
2248                                 .Append (parameters.Count);
2249                         for (int i = 0; i < parameters.Count; ++i) {
2250                                 xpath.Append (" and Parameter [").Append (i+1).Append ("]/@Type=\"");
2251                                 xpath.Append (GetDocParameterType (parameters [i].ParameterType));
2252                                 xpath.Append ("\"");
2253                         }
2254                         xpath.Append ("]/..");
2255                 }
2256                 return xpath.ToString ();
2257         }
2258 }
2259
2260 static class CecilExtensions {
2261         public static IEnumerable<MemberReference> GetMembers (this TypeDefinition type)
2262         {
2263                 foreach (var c in type.Methods.Where (m => m.IsConstructor))
2264                         yield return (MemberReference) c;
2265                 foreach (var e in type.Events)
2266                         yield return (MemberReference) e;
2267                 foreach (var f in type.Fields)
2268                         yield return (MemberReference) f;
2269                 foreach (var m in type.Methods.Where (m => !m.IsConstructor))
2270                         yield return (MemberReference) m;
2271                 foreach (var t in type.NestedTypes)
2272                         yield return (MemberReference) t;
2273                 foreach (var p in type.Properties)
2274                         yield return (MemberReference) p;
2275         }
2276
2277         public static IEnumerable<MemberReference> GetMembers (this TypeDefinition type, string member)
2278         {
2279                 return GetMembers (type).Where (m => m.Name == member);
2280         }
2281
2282         public static MemberReference GetMember (this TypeDefinition type, string member)
2283         {
2284                 return GetMembers (type, member).EnsureZeroOrOne ();
2285         }
2286
2287         static T EnsureZeroOrOne<T> (this IEnumerable<T> source)
2288         {
2289                 if (source.Count () > 1)
2290                         throw new InvalidOperationException ("too many matches");
2291                 return source.FirstOrDefault ();
2292         }
2293
2294         public static MethodDefinition GetMethod (this TypeDefinition type, string method)
2295         {
2296                 return type.Methods
2297                         .Where (m => m.Name == method)
2298                         .EnsureZeroOrOne ();
2299         }
2300
2301         public static IEnumerable<MemberReference> GetDefaultMembers (this TypeReference type)
2302         {
2303                 TypeDefinition def = type as TypeDefinition;
2304                 if (def == null)
2305                         return new MemberReference [0];
2306                 CustomAttribute defMemberAttr = def.CustomAttributes
2307                                 .FirstOrDefault (c => c.AttributeType.FullName == "System.Reflection.DefaultMemberAttribute");
2308                 if (defMemberAttr == null)
2309                         return new MemberReference [0];
2310                 string name = (string) defMemberAttr.ConstructorArguments [0].Value;
2311                 return def.Properties
2312                                 .Where (p => p.Name == name)
2313                                 .Select (p => (MemberReference) p);
2314         }
2315
2316         public static IEnumerable<TypeDefinition> GetTypes (this AssemblyDefinition assembly)
2317         {
2318                 return assembly.Modules.SelectMany (md => md.GetAllTypes ());
2319         }
2320
2321         public static TypeDefinition GetType (this AssemblyDefinition assembly, string type)
2322         {
2323                 return GetTypes (assembly)
2324                         .Where (td => td.FullName == type)
2325                         .EnsureZeroOrOne ();
2326         }
2327
2328         public static bool IsGenericType (this TypeReference type)
2329         {
2330                 return type.GenericParameters.Count > 0;
2331         }
2332
2333         public static bool IsGenericMethod (this MethodReference method)
2334         {
2335                 return method.GenericParameters.Count > 0;
2336         }
2337
2338         public static MemberReference Resolve (this MemberReference member)
2339         {
2340                 FieldReference fr = member as FieldReference;
2341                 if (fr != null)
2342                         return fr.Resolve ();
2343                 MethodReference mr = member as MethodReference;
2344                 if (mr != null)
2345                         return mr.Resolve ();
2346                 TypeReference tr = member as TypeReference;
2347                 if (tr != null)
2348                         return tr.Resolve ();
2349                 PropertyReference pr = member as PropertyReference;
2350                 if (pr != null)
2351                         return pr;
2352                 EventReference er = member as EventReference;
2353                 if (er != null)
2354                         return er;
2355                 throw new NotSupportedException ("Cannot find definition for " + member.ToString ());
2356         }
2357
2358         public static TypeReference GetUnderlyingType (this TypeDefinition type)
2359         {
2360                 if (!type.IsEnum)
2361                         return type;
2362                 return type.Fields.First (f => f.Name == "value__").FieldType;
2363         }
2364
2365         public static IEnumerable<TypeDefinition> GetAllTypes (this ModuleDefinition self)
2366         {
2367                 return self.Types.SelectMany (t => t.GetAllTypes ());
2368         }
2369
2370         static IEnumerable<TypeDefinition> GetAllTypes (this TypeDefinition self)
2371         {
2372                 yield return self;
2373
2374                 if (!self.HasNestedTypes)
2375                         yield break;
2376
2377                 foreach (var type in self.NestedTypes.SelectMany (t => t.GetAllTypes ()))
2378                         yield return type;
2379         }
2380 }
2381
2382 static class DocUtils {
2383         public static bool IsExplicitlyImplemented (MethodDefinition method)
2384         {
2385                 return method.IsPrivate && method.IsFinal && method.IsVirtual;
2386         }
2387
2388         public static string GetTypeDotMember (string name)
2389         {
2390                 int startType, startMethod;
2391                 startType = startMethod = -1;
2392                 for (int i = 0; i < name.Length; ++i) {
2393                         if (name [i] == '.') {
2394                                 startType = startMethod;
2395                                 startMethod = i;
2396                         }
2397                 }
2398                 return name.Substring (startType+1);
2399         }
2400
2401         public static string GetMember (string name)
2402         {
2403                 int i = name.LastIndexOf ('.');
2404                 if (i == -1)
2405                         return name;
2406                 return name.Substring (i+1);
2407         }
2408
2409         public static void GetInfoForExplicitlyImplementedMethod (
2410                         MethodDefinition method, out TypeReference iface, out MethodReference ifaceMethod)
2411         {
2412                 iface = null;
2413                 ifaceMethod = null;
2414                 if (method.Overrides.Count != 1)
2415                         throw new InvalidOperationException ("Could not determine interface type for explicitly-implemented interface member " + method.Name);
2416                 iface = method.Overrides [0].DeclaringType;
2417                 ifaceMethod = method.Overrides [0];
2418         }
2419
2420         public static string GetPropertyName (PropertyDefinition pi)
2421         {
2422                 // Issue: (g)mcs-generated assemblies that explicitly implement
2423                 // properties don't specify the full namespace, just the
2424                 // TypeName.Property; .NET uses Full.Namespace.TypeName.Property.
2425                 MethodDefinition method = pi.GetMethod;
2426                 if (method == null)
2427                         method = pi.SetMethod;
2428                 if (!IsExplicitlyImplemented (method))
2429                         return pi.Name;
2430
2431                 // Need to determine appropriate namespace for this member.
2432                 TypeReference iface;
2433                 MethodReference ifaceMethod;
2434                 GetInfoForExplicitlyImplementedMethod (method, out iface, out ifaceMethod);
2435                 return string.Join (".", new string[]{
2436                                 DocTypeFullMemberFormatter.Default.GetName (iface),
2437                                 GetMember (pi.Name)});
2438         }
2439
2440         public static string GetNamespace (TypeReference type)
2441         {
2442                 if (type.GetElementType ().IsNested)
2443                         type = type.GetElementType ();
2444                 while (type != null && type.IsNested)
2445                         type = type.DeclaringType;
2446                 if (type == null)
2447                         return string.Empty;
2448                 return type.Namespace;
2449         }
2450
2451         public static string PathCombine (string dir, string path)
2452         {
2453                 if (dir == null)
2454                         dir = "";
2455                 if (path == null)
2456                         path = "";
2457                 return Path.Combine (dir, path);
2458         }
2459
2460         public static bool IsExtensionMethod (MethodDefinition method)
2461         {
2462                 return
2463                         method.CustomAttributes
2464                                         .Any (m => m.AttributeType.FullName == "System.Runtime.CompilerServices.ExtensionAttribute")
2465                         && method.DeclaringType.CustomAttributes
2466                                         .Any (m => m.AttributeType.FullName == "System.Runtime.CompilerServices.ExtensionAttribute");
2467         }
2468
2469         public static bool IsDelegate (TypeDefinition type)
2470         {
2471                 TypeReference baseRef = type.BaseType;
2472                 if (baseRef == null)
2473                         return false;
2474                 return !type.IsAbstract && baseRef.FullName == "System.Delegate" || // FIXME
2475                                 baseRef.FullName == "System.MulticastDelegate";
2476         }
2477
2478         public static List<TypeReference> GetDeclaringTypes (TypeReference type)
2479         {
2480                 List<TypeReference> decls = new List<TypeReference> ();
2481                 decls.Add (type);
2482                 while (type.DeclaringType != null) {
2483                         decls.Add (type.DeclaringType);
2484                         type = type.DeclaringType;
2485                 }
2486                 decls.Reverse ();
2487                 return decls;
2488         }
2489
2490         public static int GetGenericArgumentCount (TypeReference type)
2491         {
2492                 GenericInstanceType inst = type as GenericInstanceType;
2493                 return inst != null
2494                                 ? inst.GenericArguments.Count
2495                                 : type.GenericParameters.Count;
2496         }
2497
2498         public static IEnumerable<TypeReference> GetUserImplementedInterfaces (TypeDefinition type)
2499         {
2500                 HashSet<string> inheritedInterfaces = GetInheritedInterfaces (type);
2501                 List<TypeReference> userInterfaces = new List<TypeReference> ();
2502                 foreach (TypeReference iface in type.Interfaces) {
2503                         TypeReference lookup = iface.Resolve () ?? iface;
2504                         if (!inheritedInterfaces.Contains (GetQualifiedTypeName (lookup)))
2505                                 userInterfaces.Add (iface);
2506                 }
2507                 return userInterfaces;
2508         }
2509
2510         private static string GetQualifiedTypeName (TypeReference type)
2511         {
2512                 return "[" + type.Scope.Name + "]" + type.FullName;
2513         }
2514
2515         private static HashSet<string> GetInheritedInterfaces (TypeDefinition type)
2516         {
2517                 HashSet<string> inheritedInterfaces = new HashSet<string> ();
2518                 Action<TypeDefinition> a = null;
2519                 a = t => {
2520                         if (t == null) return;
2521                         foreach (TypeReference r in t.Interfaces) {
2522                                 inheritedInterfaces.Add (GetQualifiedTypeName (r));
2523                                 a (r.Resolve ());
2524                         }
2525                 };
2526                 TypeReference baseRef = type.BaseType;
2527                 while (baseRef != null) {
2528                         TypeDefinition baseDef = baseRef.Resolve ();
2529                         if (baseDef != null) {
2530                                 a (baseDef);
2531                                 baseRef = baseDef.BaseType;
2532                         }
2533                         else
2534                                 baseRef = null;
2535                 }
2536                 foreach (TypeReference r in type.Interfaces)
2537                         a (r.Resolve ());
2538                 return inheritedInterfaces;
2539         }
2540 }
2541
2542 class DocsNodeInfo {
2543         public DocsNodeInfo (XmlElement node)
2544         {
2545                 this.Node = node;
2546         }
2547
2548         public DocsNodeInfo (XmlElement node, TypeDefinition type)
2549                 : this (node)
2550         {
2551                 SetType (type);
2552         }
2553
2554         public DocsNodeInfo (XmlElement node, MemberReference member)
2555                 : this (node)
2556         {
2557                 SetMemberInfo (member);
2558         }
2559
2560         void SetType (TypeDefinition type)
2561         {
2562                 if (type == null)
2563                         throw new ArgumentNullException ("type");
2564                 Type = type;
2565                 GenericParameters = new List<GenericParameter> (type.GenericParameters);
2566                 List<TypeReference> declTypes = DocUtils.GetDeclaringTypes (type);
2567                 int maxGenArgs = DocUtils.GetGenericArgumentCount (type);
2568                 for (int i = 0; i < declTypes.Count - 1; ++i) {
2569                         int remove = System.Math.Min (maxGenArgs,
2570                                         DocUtils.GetGenericArgumentCount (declTypes [i]));
2571                         maxGenArgs -= remove;
2572                         while (remove-- > 0)
2573                                 GenericParameters.RemoveAt (0);
2574                 }
2575                 if (DocUtils.IsDelegate (type)) {
2576                         Parameters = type.GetMethod("Invoke").Parameters;
2577                         ReturnType = type.GetMethod("Invoke").ReturnType;
2578                         ReturnIsReturn = true;
2579                 }
2580         }
2581
2582         void SetMemberInfo (MemberReference member)
2583         {
2584                 if (member == null)
2585                         throw new ArgumentNullException ("member");
2586                 ReturnIsReturn = true;
2587                 AddRemarks = true;
2588                 Member = member;
2589
2590                 if (member is MethodReference ) {
2591                         MethodReference mr = (MethodReference) member;
2592                         Parameters = mr.Parameters;
2593                         if (mr.IsGenericMethod ()) {
2594                                 GenericParameters = new List<GenericParameter> (mr.GenericParameters);
2595                         }
2596                 }
2597                 else if (member is PropertyDefinition) {
2598                         Parameters = ((PropertyDefinition) member).Parameters;
2599                 }
2600
2601                 if (member is MethodDefinition) {
2602                         ReturnType = ((MethodDefinition) member).ReturnType;
2603                 } else if (member is PropertyDefinition) {
2604                         ReturnType = ((PropertyDefinition) member).PropertyType;
2605                         ReturnIsReturn = false;
2606                 }
2607
2608                 // no remarks section for enum members
2609                 if (member.DeclaringType != null && ((TypeDefinition) member.DeclaringType).IsEnum)
2610                         AddRemarks = false;
2611         }
2612
2613         public TypeReference ReturnType;
2614         public List<GenericParameter> GenericParameters;
2615         public IList<ParameterDefinition> Parameters;
2616         public bool ReturnIsReturn;
2617         public XmlElement Node;
2618         public bool AddRemarks = true;
2619         public MemberReference Member;
2620         public TypeDefinition Type;
2621 }
2622
2623 class DocumentationEnumerator {
2624
2625         public virtual IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes)
2626         {
2627                 return GetDocumentationTypes (assembly, forTypes, null);
2628         }
2629
2630         protected IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes, HashSet<string> seen)
2631         {
2632                 foreach (TypeDefinition type in assembly.GetTypes()) {
2633                         if (forTypes != null && forTypes.BinarySearch (type.FullName) < 0)
2634                                 continue;
2635                         if (seen != null && seen.Contains (type.FullName))
2636                                 continue;
2637                         yield return type;
2638                         foreach (TypeDefinition nested in type.NestedTypes)
2639                                 yield return nested;
2640                 }
2641         }
2642
2643         public virtual IEnumerable<DocsNodeInfo> GetDocumentationMembers (XmlDocument basefile, TypeDefinition type)
2644         {
2645                 foreach (XmlElement oldmember in basefile.SelectNodes("Type/Members/Member")) {
2646                         if (oldmember.GetAttribute ("__monodocer-seen__") == "true") {
2647                                 oldmember.RemoveAttribute ("__monodocer-seen__");
2648                                 continue;
2649                         }
2650                         MemberReference m = GetMember (type, new DocumentationMember (oldmember));
2651                         if (m == null) {
2652                                 yield return new DocsNodeInfo (oldmember);
2653                         }
2654                         else {
2655                                 yield return new DocsNodeInfo (oldmember, m);
2656                         }
2657                 }
2658         }
2659
2660         protected static MemberReference GetMember (TypeDefinition type, DocumentationMember member)
2661         {
2662                 string membertype = member.MemberType;
2663
2664                 string returntype = member.ReturnType;
2665
2666                 string docName = member.MemberName;
2667                 string[] docTypeParams = GetTypeParameters (docName);
2668
2669                 // Loop through all members in this type with the same name
2670                 foreach (MemberReference mi in GetReflectionMembers (type, docName)) {
2671                         if (mi is TypeDefinition) continue;
2672                         if (MDocUpdater.GetMemberType(mi) != membertype) continue;
2673
2674                         if (MDocUpdater.IsPrivate (mi))
2675                                 continue;
2676
2677                         IList<ParameterDefinition> pis = null;
2678                         string[] typeParams = null;
2679                         if (mi is MethodDefinition) {
2680                                 MethodDefinition mb = (MethodDefinition) mi;
2681                                 pis = mb.Parameters;
2682                                 if (docTypeParams != null && mb.IsGenericMethod ()) {
2683                                         IList<GenericParameter> args = mb.GenericParameters;
2684                                         if (args.Count == docTypeParams.Length) {
2685                                                 typeParams = args.Select (p => p.Name).ToArray ();
2686                                         }
2687                                 }
2688                         }
2689                         else if (mi is PropertyDefinition)
2690                                 pis = ((PropertyDefinition)mi).Parameters;
2691
2692                         int mcount = member.Parameters == null ? 0 : member.Parameters.Count;
2693                         int pcount = pis == null ? 0 : pis.Count;
2694                         if (mcount != pcount)
2695                                 continue;
2696
2697                         MethodDefinition mDef = mi as MethodDefinition;
2698                         if (mDef != null && !mDef.IsConstructor) {
2699                                 // Casting operators can overload based on return type.
2700                                 if (returntype != GetReplacedString (
2701                                                         MDocUpdater.GetDocTypeFullName (((MethodDefinition)mi).ReturnType),
2702                                                         typeParams, docTypeParams)) {
2703                                         continue;
2704                                 }
2705                         }
2706
2707                         if (pcount == 0)
2708                                 return mi;
2709                         bool good = true;
2710                         for (int i = 0; i < pis.Count; i++) {
2711                                 string paramType = GetReplacedString (
2712                                         MDocUpdater.GetDocParameterType (pis [i].ParameterType),
2713                                         typeParams, docTypeParams);
2714                                 if (paramType != (string) member.Parameters [i]) {
2715                                         good = false;
2716                                         break;
2717                                 }
2718                         }
2719                         if (!good) continue;
2720
2721                         return mi;
2722                 }
2723
2724                 return null;
2725         }
2726
2727         static string[] GetTypeParameters (string docName)
2728         {
2729                 if (docName [docName.Length-1] != '>')
2730                         return null;
2731                 StringList types = new StringList ();
2732                 int endToken = docName.Length-2;
2733                 int i = docName.Length-2;
2734                 do {
2735                         if (docName [i] == ',' || docName [i] == '<') {
2736                                 types.Add (docName.Substring (i + 1, endToken - i));
2737                                 endToken = i-1;
2738                         }
2739                         if (docName [i] == '<')
2740                                 break;
2741                 } while (--i >= 0);
2742
2743                 types.Reverse ();
2744                 return types.ToArray ();
2745         }
2746
2747         protected static IEnumerable<MemberReference> GetReflectionMembers (TypeDefinition type, string docName)
2748         {
2749                 // need to worry about 4 forms of //@MemberName values:
2750                 //  1. "Normal" (non-generic) member names: GetEnumerator
2751                 //    - Lookup as-is.
2752                 //  2. Explicitly-implemented interface member names: System.Collections.IEnumerable.Current
2753                 //    - try as-is, and try type.member (due to "kludge" for property
2754                 //      support.
2755                 //  3. "Normal" Generic member names: Sort<T> (CSC)
2756                 //    - need to remove generic parameters --> "Sort"
2757                 //  4. Explicitly-implemented interface members for generic interfaces:
2758                 //    -- System.Collections.Generic.IEnumerable<T>.Current
2759                 //    - Try as-is, and try type.member, *keeping* the generic parameters.
2760                 //     --> System.Collections.Generic.IEnumerable<T>.Current, IEnumerable<T>.Current
2761                 //  5. As of 2008-01-02, gmcs will do e.g. 'IFoo`1[A].Method' instead of
2762                 //    'IFoo<A>.Method' for explicitly implemented methods; don't interpret
2763                 //    this as (1) or (2).
2764                 if (docName.IndexOf ('<') == -1 && docName.IndexOf ('[') == -1) {
2765                         // Cases 1 & 2
2766                         foreach (MemberReference mi in type.GetMembers (docName))
2767                                 yield return mi;
2768                         if (CountChars (docName, '.') > 0)
2769                                 // might be a property; try only type.member instead of
2770                                 // namespace.type.member.
2771                                 foreach (MemberReference mi in
2772                                                 type.GetMembers (DocUtils.GetTypeDotMember (docName)))
2773                                         yield return mi;
2774                         yield break;
2775                 }
2776                 // cases 3 & 4
2777                 int numLt = 0;
2778                 int numDot = 0;
2779                 int startLt, startType, startMethod;
2780                 startLt = startType = startMethod = -1;
2781                 for (int i = 0; i < docName.Length; ++i) {
2782                         switch (docName [i]) {
2783                                 case '<':
2784                                         if (numLt == 0) {
2785                                                 startLt = i;
2786                                         }
2787                                         ++numLt;
2788                                         break;
2789                                 case '>':
2790                                         --numLt;
2791                                         if (numLt == 0 && (i + 1) < docName.Length)
2792                                                 // there's another character in docName, so this <...> sequence is
2793                                                 // probably part of a generic type -- case 4.
2794                                                 startLt = -1;
2795                                         break;
2796                                 case '.':
2797                                         startType = startMethod;
2798                                         startMethod = i;
2799                                         ++numDot;
2800                                         break;
2801                         }
2802                 }
2803                 string refName = startLt == -1 ? docName : docName.Substring (0, startLt);
2804                 // case 3
2805                 foreach (MemberReference mi in type.GetMembers (refName))
2806                         yield return mi;
2807
2808                 // case 4
2809                 foreach (MemberReference mi in type.GetMembers (refName.Substring (startType + 1)))
2810                         yield return mi;
2811
2812                 // If we _still_ haven't found it, we've hit another generic naming issue:
2813                 // post Mono 1.1.18, gmcs generates [[FQTN]] instead of <TypeName> for
2814                 // explicitly-implemented METHOD names (not properties), e.g.
2815                 // "System.Collections.Generic.IEnumerable`1[[Foo, test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]].GetEnumerator"
2816                 // instead of "System.Collections.Generic.IEnumerable<Foo>.GetEnumerator",
2817                 // which the XML docs will contain.
2818                 //
2819                 // Alas, we can't derive the Mono name from docName, so we need to iterate
2820                 // over all member names, convert them into CSC format, and compare... :-(
2821                 if (numDot == 0)
2822                         yield break;
2823                 foreach (MemberReference mi in type.GetMembers ()) {
2824                         if (MDocUpdater.GetMemberName (mi) == docName)
2825                                 yield return mi;
2826                 }
2827         }
2828
2829         static string GetReplacedString (string typeName, string[] from, string[] to)
2830         {
2831                 if (from == null)
2832                         return typeName;
2833                 for (int i = 0; i < from.Length; ++i)
2834                         typeName = typeName.Replace (from [i], to [i]);
2835                 return typeName;
2836         }
2837
2838         private static int CountChars (string s, char c)
2839         {
2840                 int count = 0;
2841                 for (int i = 0; i < s.Length; ++i) {
2842                         if (s [i] == c)
2843                                 ++count;
2844                 }
2845                 return count;
2846         }
2847 }
2848
2849 class EcmaDocumentationEnumerator : DocumentationEnumerator {
2850
2851         XmlReader ecmadocs;
2852         MDocUpdater app;
2853
2854         public EcmaDocumentationEnumerator (MDocUpdater app, XmlReader ecmaDocs)
2855         {
2856                 this.app      = app;
2857                 this.ecmadocs = ecmaDocs;
2858         }
2859
2860         public override IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes)
2861         {
2862                 HashSet<string> seen = new HashSet<string> ();
2863                 return GetDocumentationTypes (assembly, forTypes, seen)
2864                         .Concat (base.GetDocumentationTypes (assembly, forTypes, seen));
2865         }
2866
2867         new IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes, HashSet<string> seen)
2868         {
2869                 int typeDepth = -1;
2870                 while (ecmadocs.Read ()) {
2871                         switch (ecmadocs.Name) {
2872                                 case "Type": {
2873                                         if (typeDepth == -1)
2874                                                 typeDepth = ecmadocs.Depth;
2875                                         if (ecmadocs.NodeType != XmlNodeType.Element)
2876                                                 continue;
2877                                         if (typeDepth != ecmadocs.Depth) // nested <TypeDefinition/> element?
2878                                                 continue;
2879                                         string typename = ecmadocs.GetAttribute ("FullName");
2880                                         string typename2 = MDocUpdater.GetTypeFileName (typename);
2881                                         if (forTypes != null &&
2882                                                         forTypes.BinarySearch (typename) < 0 &&
2883                                                         typename != typename2 &&
2884                                                         forTypes.BinarySearch (typename2) < 0)
2885                                                 continue;
2886                                         TypeDefinition t;
2887                                         if ((t = assembly.GetType (typename)) == null &&
2888                                                         (t = assembly.GetType (typename2)) == null)
2889                                                 continue;
2890                                         seen.Add (typename);
2891                                         if (typename != typename2)
2892                                                 seen.Add (typename2);
2893                                         Console.WriteLine ("  Import: {0}", t.FullName);
2894                                         if (ecmadocs.Name != "Docs") {
2895                                                 int depth = ecmadocs.Depth;
2896                                                 while (ecmadocs.Read ()) {
2897                                                         if (ecmadocs.Name == "Docs" && ecmadocs.Depth == depth + 1)
2898                                                                 break;
2899                                                 }
2900                                         }
2901                                         if (!ecmadocs.IsStartElement ("Docs"))
2902                                                 throw new InvalidOperationException ("Found " + ecmadocs.Name + "; expecting <Docs/>!");
2903                                         yield return t;
2904                                         break;
2905                                 }
2906                                 default:
2907                                         break;
2908                         }
2909                 }
2910         }
2911
2912         public override IEnumerable<DocsNodeInfo> GetDocumentationMembers (XmlDocument basefile, TypeDefinition type)
2913         {
2914                 return GetMembers (basefile, type)
2915                         .Concat (base.GetDocumentationMembers (basefile, type));
2916         }
2917
2918         private IEnumerable<DocsNodeInfo> GetMembers (XmlDocument basefile, TypeDefinition type)
2919         {
2920                 while (ecmadocs.Name != "Members" && ecmadocs.Read ()) {
2921                         // do nothing
2922                 }
2923                 if (ecmadocs.IsEmptyElement)
2924                         yield break;
2925
2926                 int membersDepth = ecmadocs.Depth;
2927                 bool go = true;
2928                 while (go && ecmadocs.Read ()) {
2929                         switch (ecmadocs.Name) {
2930                                 case "Member": {
2931                                         if (membersDepth != ecmadocs.Depth - 1 || ecmadocs.NodeType != XmlNodeType.Element)
2932                                                 continue;
2933                                         DocumentationMember dm = new DocumentationMember (ecmadocs);
2934                                         string xp = MDocUpdater.GetXPathForMember (dm);
2935                                         XmlElement oldmember = (XmlElement) basefile.SelectSingleNode (xp);
2936                                         MemberReference m;
2937                                         if (oldmember == null) {
2938                                                 m = GetMember (type, dm);
2939                                                 if (m == null) {
2940                                                         app.Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
2941                                                                         type.FullName, dm.MemberSignatures ["C#"]);
2942                                                                         // SelectSingleNode (ecmaDocsMember, "MemberSignature[@Language=\"C#\"]/@Value").Value);
2943                                                         continue;
2944                                                 }
2945                                                 // oldmember lookup may have failed due to type parameter renames.
2946                                                 // Try again.
2947                                                 oldmember = (XmlElement) basefile.SelectSingleNode (MDocUpdater.GetXPathForMember (m));
2948                                                 if (oldmember == null) {
2949                                                         XmlElement members = MDocUpdater.WriteElement (basefile.DocumentElement, "Members");
2950                                                         oldmember = basefile.CreateElement ("Member");
2951                                                         oldmember.SetAttribute ("MemberName", dm.MemberName);
2952                                                         members.AppendChild (oldmember);
2953                                                         foreach (string key in MDocUpdater.Sort (dm.MemberSignatures.Keys)) {
2954                                                                 XmlElement ms = basefile.CreateElement ("MemberSignature");
2955                                                                 ms.SetAttribute ("Language", key);
2956                                                                 ms.SetAttribute ("Value", (string) dm.MemberSignatures [key]);
2957                                                                 oldmember.AppendChild (ms);
2958                                                         }
2959                                                         oldmember.SetAttribute ("__monodocer-seen__", "true");
2960                                                         Console.WriteLine ("Member Added: {0}", oldmember.SelectSingleNode("MemberSignature[@Language='C#']/@Value").InnerText);
2961                                                         app.additions++;
2962                                                 }
2963                                         }
2964                                         else {
2965                                                 m = GetMember (type, new DocumentationMember (oldmember));
2966                                                 if (m == null) {
2967                                                         app.Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
2968                                                                         type.FullName, dm.MemberSignatures ["C#"]);
2969                                                         continue;
2970                                                 }
2971                                                 oldmember.SetAttribute ("__monodocer-seen__", "true");
2972                                         }
2973                                         DocsNodeInfo node = new DocsNodeInfo (oldmember, m);
2974                                         if (ecmadocs.Name != "Docs")
2975                                                 throw new InvalidOperationException ("Found " + ecmadocs.Name + "; expected <Docs/>!");
2976                                         yield return node;
2977                                         break;
2978                                 }
2979                                 case "Members":
2980                                         if (membersDepth == ecmadocs.Depth && ecmadocs.NodeType == XmlNodeType.EndElement) {
2981                                                 go = false;
2982                                         }
2983                                         break;
2984                         }
2985                 }
2986         }
2987 }
2988
2989 abstract class DocumentationImporter {
2990
2991         public abstract void ImportDocumentation (DocsNodeInfo info);
2992 }
2993
2994 class MsxdocDocumentationImporter : DocumentationImporter {
2995
2996         XmlDocument slashdocs;
2997
2998         public MsxdocDocumentationImporter (string file)
2999         {
3000                 var xml = File.ReadAllText (file);
3001
3002                 // Ensure Unix line endings
3003                 xml = xml.Replace ("\r", "");
3004
3005                 slashdocs = new XmlDocument();
3006                 slashdocs.LoadXml (xml);
3007         }
3008
3009         public override void ImportDocumentation (DocsNodeInfo info)
3010         {
3011                 XmlNode elem = GetDocs (info.Member ?? info.Type);
3012
3013                 if (elem == null)
3014                         return;
3015
3016                 XmlElement e = info.Node;
3017
3018                 if (elem.SelectSingleNode("summary") != null)
3019                         MDocUpdater.ClearElement(e, "summary");
3020                 if (elem.SelectSingleNode("remarks") != null)
3021                         MDocUpdater.ClearElement(e, "remarks");
3022                 if (elem.SelectSingleNode ("value") != null || elem.SelectSingleNode ("returns") != null) {
3023                         MDocUpdater.ClearElement(e, "value");
3024                         MDocUpdater.ClearElement(e, "returns");
3025                 }
3026
3027                 foreach (XmlNode child in elem.ChildNodes) {
3028                         switch (child.Name) {
3029                                 case "param":
3030                                 case "typeparam": {
3031                                         XmlAttribute name = child.Attributes ["name"];
3032                                         if (name == null)
3033                                                 break;
3034                                         XmlElement p2 = (XmlElement) e.SelectSingleNode (child.Name + "[@name='" + name.Value + "']");
3035                                         if (p2 != null)
3036                                                 p2.InnerXml = child.InnerXml;
3037                                         break;
3038                                 }
3039                                 // Occasionally XML documentation will use <returns/> on
3040                                 // properties, so let's try to normalize things.
3041                                 case "value":
3042                                 case "returns": {
3043                                         XmlElement v = e.OwnerDocument.CreateElement (info.ReturnIsReturn ? "returns" : "value");
3044                                         v.InnerXml = child.InnerXml;
3045                                         e.AppendChild (v);
3046                                         break;
3047                                 }
3048                                 case "altmember":
3049                                 case "exception":
3050                                 case "permission": {
3051                                         XmlAttribute cref = child.Attributes ["cref"] ?? child.Attributes ["name"];
3052                                         if (cref == null)
3053                                                 break;
3054                                         XmlElement a = (XmlElement) e.SelectSingleNode (child.Name + "[@cref='" + cref.Value + "']");
3055                                         if (a == null) {
3056                                                 a = e.OwnerDocument.CreateElement (child.Name);
3057                                                 a.SetAttribute ("cref", child.Attributes ["cref"].Value);
3058                                                 e.AppendChild (a);
3059                                         }
3060                                         a.InnerXml = child.InnerXml;
3061                                         break;
3062                                 }
3063                                 case "seealso": {
3064                                         XmlAttribute cref = child.Attributes ["cref"];
3065                                         if (cref == null)
3066                                                 break;
3067                                         XmlElement a = (XmlElement) e.SelectSingleNode ("altmember[@cref='" + cref.Value + "']");
3068                                         if (a == null) {
3069                                                 a = e.OwnerDocument.CreateElement ("altmember");
3070                                                 a.SetAttribute ("cref", child.Attributes ["cref"].Value);
3071                                                 e.AppendChild (a);
3072                                         }
3073                                         break;
3074                                 }
3075                                 default: {
3076                                         bool add = true;
3077                                         if (child.NodeType == XmlNodeType.Element &&
3078                                                         e.SelectNodes (child.Name).Cast<XmlElement>().Any (n => n.OuterXml == child.OuterXml))
3079                                                 add = false;
3080                                         if (add)
3081                                                 MDocUpdater.CopyNode (child, e);
3082                                         break;
3083                                 }
3084                         }
3085                 }
3086         }
3087
3088         private XmlNode GetDocs (MemberReference member)
3089         {
3090                 string slashdocsig = MDocUpdater.slashdocFormatter.GetDeclaration (member);
3091                 if (slashdocsig != null)
3092                         return slashdocs.SelectSingleNode ("doc/members/member[@name='" + slashdocsig + "']");
3093                 return null;
3094         }
3095 }
3096
3097 class EcmaDocumentationImporter : DocumentationImporter {
3098
3099         XmlReader ecmadocs;
3100
3101         public EcmaDocumentationImporter (XmlReader ecmaDocs)
3102         {
3103                 this.ecmadocs = ecmaDocs;
3104         }
3105
3106         public override void ImportDocumentation (DocsNodeInfo info)
3107         {
3108                 if (!ecmadocs.IsStartElement ("Docs")) {
3109                         return;
3110                 }
3111
3112                 XmlElement e = info.Node;
3113
3114                 int depth = ecmadocs.Depth;
3115                 ecmadocs.ReadStartElement ("Docs");
3116                 while (ecmadocs.Read ()) {
3117                         if (ecmadocs.Name == "Docs") {
3118                                 if (ecmadocs.Depth == depth && ecmadocs.NodeType == XmlNodeType.EndElement)
3119                                         break;
3120                                 else
3121                                         throw new InvalidOperationException ("Skipped past current <Docs/> element!");
3122                         }
3123                         if (!ecmadocs.IsStartElement ())
3124                                 continue;
3125                         switch (ecmadocs.Name) {
3126                                 case "param":
3127                                 case "typeparam": {
3128                                         string name = ecmadocs.GetAttribute ("name");
3129                                         if (name == null)
3130                                                 break;
3131                                         XmlNode doc = e.SelectSingleNode (
3132                                                         ecmadocs.Name + "[@name='" + name + "']");
3133                                         string value = ecmadocs.ReadInnerXml ();
3134                                         if (doc != null)
3135                                                 doc.InnerXml = value.Replace ("\r", "");
3136                                         break;
3137                                 }
3138                                 case "altmember":
3139                                 case "exception":
3140                                 case "permission":
3141                                 case "seealso": {
3142                                         string name = ecmadocs.Name;
3143                                         string cref = ecmadocs.GetAttribute ("cref");
3144                                         if (cref == null)
3145                                                 break;
3146                                         XmlNode doc = e.SelectSingleNode (
3147                                                         ecmadocs.Name + "[@cref='" + cref + "']");
3148                                         string value = ecmadocs.ReadInnerXml ().Replace ("\r", "");
3149                                         if (doc != null)
3150                                                 doc.InnerXml = value;
3151                                         else {
3152                                                 XmlElement n = e.OwnerDocument.CreateElement (name);
3153                                                 n.SetAttribute ("cref", cref);
3154                                                 n.InnerXml = value;
3155                                                 e.AppendChild (n);
3156                                         }
3157                                         break;
3158                                 }
3159                                 default: {
3160                                         string name = ecmadocs.Name;
3161                                         string xpath = ecmadocs.Name;
3162                                         StringList attributes = new StringList (ecmadocs.AttributeCount);
3163                                         if (ecmadocs.MoveToFirstAttribute ()) {
3164                                                 do {
3165                                                         attributes.Add ("@" + ecmadocs.Name + "=\"" + ecmadocs.Value + "\"");
3166                                                 } while (ecmadocs.MoveToNextAttribute ());
3167                                                 ecmadocs.MoveToContent ();
3168                                         }
3169                                         if (attributes.Count > 0) {
3170                                                 xpath += "[" + string.Join (" and ", attributes.ToArray ()) + "]";
3171                                         }
3172                                         XmlNode doc = e.SelectSingleNode (xpath);
3173                                         string value = ecmadocs.ReadInnerXml ().Replace ("\r", "");
3174                                         if (doc != null) {
3175                                                 doc.InnerXml = value;
3176                                         }
3177                                         else {
3178                                                 XmlElement n = e.OwnerDocument.CreateElement (name);
3179                                                 n.InnerXml = value;
3180                                                 foreach (string a in attributes) {
3181                                                         int eq = a.IndexOf ('=');
3182                                                         n.SetAttribute (a.Substring (1, eq-1), a.Substring (eq+2, a.Length-eq-3));
3183                                                 }
3184                                                 e.AppendChild (n);
3185                                         }
3186                                         break;
3187                                 }
3188                         }
3189                 }
3190         }
3191 }
3192
3193 class DocumentationMember {
3194         public StringToStringMap MemberSignatures = new StringToStringMap ();
3195         public string ReturnType;
3196         public StringList Parameters;
3197         public string MemberName;
3198         public string MemberType;
3199
3200         public DocumentationMember (XmlReader reader)
3201         {
3202                 MemberName = reader.GetAttribute ("MemberName");
3203                 int depth = reader.Depth;
3204                 bool go = true;
3205                 StringList p = new StringList ();
3206                 do {
3207                         if (reader.NodeType != XmlNodeType.Element)
3208                                 continue;
3209                         switch (reader.Name) {
3210                                 case "MemberSignature":
3211                                         MemberSignatures [reader.GetAttribute ("Language")] = reader.GetAttribute ("Value");
3212                                         break;
3213                                 case "MemberType":
3214                                         MemberType = reader.ReadElementString ();
3215                                         break;
3216                                 case "ReturnType":
3217                                         if (reader.Depth == depth + 2)
3218                                                 ReturnType = reader.ReadElementString ();
3219                                         break;
3220                                 case "Parameter":
3221                                         if (reader.Depth == depth + 2)
3222                                                 p.Add (reader.GetAttribute ("Type"));
3223                                         break;
3224                                 case "Docs":
3225                                         if (reader.Depth == depth + 1)
3226                                                 go = false;
3227                                         break;
3228                         }
3229                 } while (go && reader.Read () && reader.Depth >= depth);
3230                 if (p.Count > 0) {
3231                         Parameters = p;
3232                 }
3233         }
3234
3235         public DocumentationMember (XmlNode node)
3236         {
3237                 MemberName = node.Attributes ["MemberName"].Value;
3238                 foreach (XmlNode n in node.SelectNodes ("MemberSignature")) {
3239                         XmlAttribute l = n.Attributes ["Language"];
3240                         XmlAttribute v = n.Attributes ["Value"];
3241                         if (l != null && v != null)
3242                                 MemberSignatures [l.Value] = v.Value;
3243                 }
3244                 MemberType = node.SelectSingleNode ("MemberType").InnerText;
3245                 XmlNode rt = node.SelectSingleNode ("ReturnValue/ReturnType");
3246                 if (rt != null)
3247                         ReturnType = rt.InnerText;
3248                 XmlNodeList p = node.SelectNodes ("Parameters/Parameter");
3249                 if (p.Count > 0) {
3250                         Parameters = new StringList (p.Count);
3251                         for (int i = 0; i < p.Count; ++i)
3252                                 Parameters.Add (p [i].Attributes ["Type"].Value);
3253                 }
3254         }
3255 }
3256
3257 public enum MemberFormatterState {
3258         None,
3259         WithinArray,
3260         WithinGenericTypeParameters,
3261 }
3262
3263 public abstract class MemberFormatter {
3264
3265         public virtual string Language {
3266                 get {return "";}
3267         }
3268
3269         public virtual string GetName (MemberReference member)
3270         {
3271                 TypeReference type = member as TypeReference;
3272                 if (type != null)
3273                         return GetTypeName (type);
3274                 MethodReference method  = member as MethodReference;
3275                 if (method != null && method.Name == ".ctor") // method.IsConstructor
3276                         return GetConstructorName (method);
3277                 if (method != null)
3278                         return GetMethodName (method);
3279                 PropertyReference prop = member as PropertyReference;
3280                 if (prop != null)
3281                         return GetPropertyName (prop);
3282                 FieldReference field = member as FieldReference;
3283                 if (field != null)
3284                         return GetFieldName (field);
3285                 EventReference e = member as EventReference;
3286                 if (e != null)
3287                         return GetEventName (e);
3288                 throw new NotSupportedException ("Can't handle: " +
3289                                         (member == null ? "null" : member.GetType().ToString()));
3290         }
3291
3292         protected virtual string GetTypeName (TypeReference type)
3293         {
3294                 if (type == null)
3295                         throw new ArgumentNullException ("type");
3296                 return _AppendTypeName (new StringBuilder (type.Name.Length), type).ToString ();
3297         }
3298
3299         protected virtual char[] ArrayDelimeters {
3300                 get {return new char[]{'[', ']'};}
3301         }
3302
3303         protected virtual MemberFormatterState MemberFormatterState { get; set; }
3304
3305         protected StringBuilder _AppendTypeName (StringBuilder buf, TypeReference type)
3306         {
3307                 if (type is ArrayType) {
3308                         TypeSpecification spec = type as TypeSpecification;
3309                         _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetElementType ())
3310                                         .Append (ArrayDelimeters [0]);
3311                         var origState = MemberFormatterState;
3312                         MemberFormatterState = MemberFormatterState.WithinArray;
3313                         ArrayType array = (ArrayType) type;
3314                         int rank = array.Rank;
3315                         if (rank > 1)
3316                                 buf.Append (new string (',', rank-1));
3317                         MemberFormatterState = origState;
3318                         return buf.Append (ArrayDelimeters [1]);
3319                 }
3320                 if (type is ByReferenceType) {
3321                         return AppendRefTypeName (buf, type);
3322                 }
3323                 if (type is PointerType) {
3324                         return AppendPointerTypeName (buf, type);
3325                 }
3326                 AppendNamespace (buf, type);
3327                 if (type is GenericParameter) {
3328                         return AppendTypeName (buf, type);
3329                 }
3330                 GenericInstanceType genInst = type as GenericInstanceType;
3331                 if (type.GenericParameters.Count == 0 &&
3332                                 (genInst == null ? true : genInst.GenericArguments.Count == 0)) {
3333                         return AppendFullTypeName (buf, type);
3334                 }
3335                 return AppendGenericType (buf, type);
3336         }
3337
3338         protected virtual StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
3339         {
3340                 string ns = DocUtils.GetNamespace (type);
3341                 if (ns != null && ns.Length > 0)
3342                         buf.Append (ns).Append ('.');
3343                 return buf;
3344         }
3345
3346         protected virtual StringBuilder AppendFullTypeName (StringBuilder buf, TypeReference type)
3347         {
3348                 if (type.DeclaringType != null)
3349                         AppendFullTypeName (buf, type.DeclaringType).Append (NestedTypeSeparator);
3350                 return AppendTypeName (buf, type);
3351         }
3352
3353         protected virtual StringBuilder AppendTypeName (StringBuilder buf, TypeReference type)
3354         {
3355                 return AppendTypeName (buf, type.Name);
3356         }
3357
3358         protected virtual StringBuilder AppendTypeName (StringBuilder buf, string typename)
3359         {
3360                 int n = typename.IndexOf ("`");
3361                 if (n >= 0)
3362                         return buf.Append (typename.Substring (0, n));
3363                 return buf.Append (typename);
3364         }
3365
3366         protected virtual string RefTypeModifier {
3367                 get {return "@";}
3368         }
3369
3370         protected virtual StringBuilder AppendRefTypeName (StringBuilder buf, TypeReference type)
3371         {
3372                 TypeSpecification spec = type as TypeSpecification;
3373                 return _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetElementType ())
3374                                 .Append (RefTypeModifier);
3375         }
3376
3377         protected virtual string PointerModifier {
3378                 get {return "*";}
3379         }
3380
3381         protected virtual StringBuilder AppendPointerTypeName (StringBuilder buf, TypeReference type)
3382         {
3383                 TypeSpecification spec = type as TypeSpecification;
3384                 return _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetElementType ())
3385                                 .Append (PointerModifier);
3386         }
3387
3388         protected virtual char[] GenericTypeContainer {
3389                 get {return new char[]{'<', '>'};}
3390         }
3391
3392         protected virtual char NestedTypeSeparator {
3393                 get {return '.';}
3394         }
3395
3396         protected virtual StringBuilder AppendGenericType (StringBuilder buf, TypeReference type)
3397         {
3398                 List<TypeReference> decls = DocUtils.GetDeclaringTypes (
3399                                 type is GenericInstanceType ? type.GetElementType () : type);
3400                 List<TypeReference> genArgs = GetGenericArguments (type);
3401                 int argIdx = 0;
3402                 int prev = 0;
3403                 bool insertNested = false;
3404                 foreach (var decl in decls) {
3405                         TypeReference declDef = decl.Resolve () ?? decl;
3406                         if (insertNested) {
3407                                 buf.Append (NestedTypeSeparator);
3408                         }
3409                         insertNested = true;
3410                         AppendTypeName (buf, declDef);
3411                         int ac = DocUtils.GetGenericArgumentCount (declDef);
3412                         int c = ac - prev;
3413                         prev = ac;
3414                         if (c > 0) {
3415                                 buf.Append (GenericTypeContainer [0]);
3416                                 var origState = MemberFormatterState;
3417                                 MemberFormatterState = MemberFormatterState.WithinGenericTypeParameters;
3418                                 _AppendTypeName (buf, genArgs [argIdx++]);
3419                                 for (int i = 1; i < c; ++i)
3420                                         _AppendTypeName (buf.Append (","), genArgs [argIdx++]);
3421                                 MemberFormatterState = origState;
3422                                 buf.Append (GenericTypeContainer [1]);
3423                         }
3424                 }
3425                 return buf;
3426         }
3427
3428         protected List<TypeReference> GetGenericArguments (TypeReference type)
3429         {
3430                 var args = new List<TypeReference> ();
3431                 GenericInstanceType inst = type as GenericInstanceType;
3432                 if (inst != null)
3433                         args.AddRange (inst.GenericArguments.Cast<TypeReference> ());
3434                 else
3435                         args.AddRange (type.GenericParameters.Cast<TypeReference> ());
3436                 return args;
3437         }
3438
3439         protected virtual StringBuilder AppendGenericTypeConstraints (StringBuilder buf, TypeReference type)
3440         {
3441                 return buf;
3442         }
3443
3444         protected virtual string GetConstructorName (MethodReference constructor)
3445         {
3446                 return constructor.Name;
3447         }
3448
3449         protected virtual string GetMethodName (MethodReference method)
3450         {
3451                 return method.Name;
3452         }
3453
3454         protected virtual string GetPropertyName (PropertyReference property)
3455         {
3456                 return property.Name;
3457         }
3458
3459         protected virtual string GetFieldName (FieldReference field)
3460         {
3461                 return field.Name;
3462         }
3463
3464         protected virtual string GetEventName (EventReference e)
3465         {
3466                 return e.Name;
3467         }
3468
3469         public virtual string GetDeclaration (MemberReference member)
3470         {
3471                 if (member == null)
3472                         throw new ArgumentNullException ("member");
3473                 TypeDefinition type = member as TypeDefinition;
3474                 if (type != null)
3475                         return GetTypeDeclaration (type);
3476                 MethodDefinition method = member as MethodDefinition;
3477                 if (method != null && method.IsConstructor)
3478                         return GetConstructorDeclaration (method);
3479                 if (method != null)
3480                         return GetMethodDeclaration (method);
3481                 PropertyDefinition prop = member as PropertyDefinition;
3482                 if (prop != null)
3483                         return GetPropertyDeclaration (prop);
3484                 FieldDefinition field = member as FieldDefinition;
3485                 if (field != null)
3486                         return GetFieldDeclaration (field);
3487                 EventDefinition e = member as EventDefinition;
3488                 if (e != null)
3489                         return GetEventDeclaration (e);
3490                 throw new NotSupportedException ("Can't handle: " + member.GetType().ToString());
3491         }
3492
3493         protected virtual string GetTypeDeclaration (TypeDefinition type)
3494         {
3495                 if (type == null)
3496                         throw new ArgumentNullException ("type");
3497                 StringBuilder buf = new StringBuilder (type.Name.Length);
3498                 _AppendTypeName (buf, type);
3499                 AppendGenericTypeConstraints (buf, type);
3500                 return buf.ToString ();
3501         }
3502
3503         protected virtual string GetConstructorDeclaration (MethodDefinition constructor)
3504         {
3505                 return GetConstructorName (constructor);
3506         }
3507
3508         protected virtual string GetMethodDeclaration (MethodDefinition method)
3509         {
3510                 // Special signature for destructors.
3511                 if (method.Name == "Finalize" && method.Parameters.Count == 0)
3512                         return GetFinalizerName (method);
3513
3514                 StringBuilder buf = new StringBuilder ();
3515
3516                 AppendVisibility (buf, method);
3517                 if (buf.Length == 0 &&
3518                                 !(DocUtils.IsExplicitlyImplemented (method) && !method.IsSpecialName))
3519                         return null;
3520
3521                 AppendModifiers (buf, method);
3522
3523                 if (buf.Length != 0)
3524                         buf.Append (" ");
3525                 buf.Append (GetTypeName (method.MethodReturnType)).Append (" ");
3526
3527                 AppendMethodName (buf, method);
3528                 AppendGenericMethod (buf, method).Append (" ");
3529                 AppendParameters (buf, method, method.Parameters);
3530                 AppendGenericMethodConstraints (buf, method);
3531                 return buf.ToString ();
3532         }
3533
3534         protected virtual string GetTypeName (MethodReturnType returnType)
3535         {
3536                 return GetName (returnType.ReturnType);
3537         }
3538
3539         protected virtual StringBuilder AppendMethodName (StringBuilder buf, MethodDefinition method)
3540         {
3541                 return buf.Append (method.Name);
3542         }
3543
3544         protected virtual string GetFinalizerName (MethodDefinition method)
3545         {
3546                 return "Finalize";
3547         }
3548
3549         protected virtual StringBuilder AppendVisibility (StringBuilder buf, MethodDefinition method)
3550         {
3551                 return buf;
3552         }
3553
3554         protected virtual StringBuilder AppendModifiers (StringBuilder buf, MethodDefinition method)
3555         {
3556                 return buf;
3557         }
3558
3559         protected virtual StringBuilder AppendGenericMethod (StringBuilder buf, MethodDefinition method)
3560         {
3561                 return buf;
3562         }
3563
3564         protected virtual StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters)
3565         {
3566                 return buf;
3567         }
3568
3569         protected virtual StringBuilder AppendGenericMethodConstraints (StringBuilder buf, MethodDefinition method)
3570         {
3571                 return buf;
3572         }
3573
3574         protected virtual string GetPropertyDeclaration (PropertyDefinition property)
3575         {
3576                 return GetPropertyName (property);
3577         }
3578
3579         protected virtual string GetFieldDeclaration (FieldDefinition field)
3580         {
3581                 return GetFieldName (field);
3582         }
3583
3584         protected virtual string GetEventDeclaration (EventDefinition e)
3585         {
3586                 return GetEventName (e);
3587         }
3588 }
3589
3590 class ILFullMemberFormatter : MemberFormatter {
3591
3592         public override string Language {
3593                 get {return "ILAsm";}
3594         }
3595
3596         protected override char NestedTypeSeparator {
3597                 get {
3598                         return '/';
3599                 }
3600         }
3601
3602         protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
3603         {
3604                 if (GetBuiltinType (type.FullName) != null)
3605                         return buf;
3606                 string ns = DocUtils.GetNamespace (type);
3607                 if (ns != null && ns.Length > 0) {
3608                         if (type.IsValueType)
3609                                 buf.Append ("valuetype ");
3610                         else
3611                                 buf.Append ("class ");
3612                         buf.Append (ns).Append ('.');
3613                 }
3614                 return buf;
3615         }
3616
3617         private static string GetBuiltinType (string t)
3618         {
3619                 switch (t) {
3620                 case "System.Byte":    return "unsigned int8";
3621                 case "System.SByte":   return "int8";
3622                 case "System.Int16":   return "int16";
3623                 case "System.Int32":   return "int32";
3624                 case "System.Int64":   return "int64";
3625                 case "System.IntPtr":  return "native int";
3626
3627                 case "System.UInt16":  return "unsigned int16";
3628                 case "System.UInt32":  return "unsigned int32";
3629                 case "System.UInt64":  return "unsigned int64";
3630                 case "System.UIntPtr": return "native unsigned int";
3631
3632                 case "System.Single":  return "float32";
3633                 case "System.Double":  return "float64";
3634                 case "System.Boolean": return "bool";
3635                 case "System.Char":    return "char";
3636                 case "System.Void":    return "void";
3637                 case "System.String":  return "string";
3638                 case "System.Object":  return "object";
3639                 }
3640                 return null;
3641         }
3642
3643         protected override StringBuilder AppendTypeName (StringBuilder buf, string typename)
3644         {
3645                 return buf.Append (typename);
3646         }
3647
3648         protected override StringBuilder AppendTypeName (StringBuilder buf, TypeReference type)
3649         {
3650                 if (type is GenericParameter)
3651                         return AppendGenericParameterConstraints (buf, (GenericParameter) type).Append (type.Name);
3652
3653                 string s = GetBuiltinType (type.FullName);
3654                 if (s != null)
3655                         return buf.Append (s);
3656                 return base.AppendTypeName (buf, type);
3657         }
3658
3659         private StringBuilder AppendGenericParameterConstraints (StringBuilder buf, GenericParameter type)
3660         {
3661                 if (MemberFormatterState != MemberFormatterState.WithinGenericTypeParameters) {
3662                         return buf.Append (type.Owner is TypeReference ? "!" : "!!");
3663                 }
3664                 GenericParameterAttributes attrs = type.Attributes;
3665                 if ((attrs & GenericParameterAttributes.ReferenceTypeConstraint) != 0)
3666                         buf.Append ("class ");
3667                 if ((attrs & GenericParameterAttributes.NotNullableValueTypeConstraint) != 0)
3668                         buf.Append ("struct ");
3669                 if ((attrs & GenericParameterAttributes.DefaultConstructorConstraint) != 0)
3670                         buf.Append (".ctor ");
3671                 IList<TypeReference> constraints = type.Constraints;
3672                 MemberFormatterState = 0;
3673                 if (constraints.Count > 0) {
3674                         var full = new ILFullMemberFormatter ();
3675                         buf.Append ("(").Append (full.GetName (constraints [0]));
3676                         for (int i = 1; i < constraints.Count; ++i) {
3677                                 buf.Append (", ").Append (full.GetName (constraints [i]));
3678                         }
3679                         buf.Append (") ");
3680                 }
3681                 MemberFormatterState = MemberFormatterState.WithinGenericTypeParameters;
3682
3683                 if ((attrs & GenericParameterAttributes.Covariant) != 0)
3684                         buf.Append ("+ ");
3685                 if ((attrs & GenericParameterAttributes.Contravariant) != 0)
3686                         buf.Append ("- ");
3687                 return buf;
3688         }
3689
3690         protected override string GetTypeDeclaration (TypeDefinition type)
3691         {
3692                 string visibility = GetTypeVisibility (type.Attributes);
3693                 if (visibility == null)
3694                         return null;
3695
3696                 StringBuilder buf = new StringBuilder ();
3697
3698                 buf.Append (".class ");
3699                 if (type.IsNested)
3700                         buf.Append ("nested ");
3701                 buf.Append (visibility).Append (" ");
3702                 if (type.IsInterface)
3703                         buf.Append ("interface ");
3704                 if (type.IsSequentialLayout)
3705                         buf.Append ("sequential ");
3706                 if (type.IsAutoLayout)
3707                         buf.Append ("auto ");
3708                 if (type.IsAnsiClass)
3709                         buf.Append ("ansi ");
3710                 if (type.IsAbstract)
3711                         buf.Append ("abstract ");
3712                 if (type.IsSerializable)
3713                         buf.Append ("serializable ");
3714                 if (type.IsSealed)
3715                         buf.Append ("sealed ");
3716                 if (type.IsBeforeFieldInit)
3717                         buf.Append ("beforefieldinit ");
3718                 var state = MemberFormatterState;
3719                 MemberFormatterState = MemberFormatterState.WithinGenericTypeParameters;
3720                 buf.Append (GetName (type));
3721                 MemberFormatterState = state;
3722                 var full = new ILFullMemberFormatter ();
3723                 if (type.BaseType != null) {
3724                         buf.Append (" extends ");
3725                         if (type.BaseType.FullName == "System.Object")
3726                                 buf.Append ("System.Object");
3727                         else
3728                                 buf.Append (full.GetName (type.BaseType).Substring ("class ".Length));
3729                 }
3730                 bool first = true;
3731                 foreach (var name in type.Interfaces
3732                                 .Select (i => full.GetName (i))
3733                                 .OrderBy (n => n)) {
3734                         if (first) {
3735                                 buf.Append (" implements ");
3736                                 first = false;
3737                         }
3738                         else {
3739                                 buf.Append (", ");
3740                         }
3741                         buf.Append (name);
3742                 }
3743
3744                 return buf.ToString ();
3745         }
3746
3747         protected override StringBuilder AppendGenericType (StringBuilder buf, TypeReference type)
3748         {
3749                 List<TypeReference> decls = DocUtils.GetDeclaringTypes (
3750                                 type is GenericInstanceType ? type.GetElementType () : type);
3751                 bool first = true;
3752                 foreach (var decl in decls) {
3753                         TypeReference declDef = decl.Resolve () ?? decl;
3754                         if (!first) {
3755                                 buf.Append (NestedTypeSeparator);
3756                         }
3757                         first = false;
3758                         AppendTypeName (buf, declDef);
3759                 }
3760                 buf.Append ('<');
3761                 first = true;
3762                 foreach (TypeReference arg in GetGenericArguments (type)) {
3763                         if (!first)
3764                                 buf.Append (", ");
3765                         first = false;
3766                         _AppendTypeName (buf, arg);
3767                 }
3768                 buf.Append ('>');
3769                 return buf;
3770         }
3771
3772         static string GetTypeVisibility (TypeAttributes ta)
3773         {
3774                 switch (ta & TypeAttributes.VisibilityMask) {
3775                 case TypeAttributes.Public:
3776                 case TypeAttributes.NestedPublic:
3777                         return "public";
3778
3779                 case TypeAttributes.NestedFamily:
3780                 case TypeAttributes.NestedFamORAssem:
3781                         return "protected";
3782
3783                 default:
3784                         return null;
3785                 }
3786         }
3787
3788         protected override string GetConstructorDeclaration (MethodDefinition constructor)
3789         {
3790                 return GetMethodDeclaration (constructor);
3791         }
3792
3793         protected override string GetMethodDeclaration (MethodDefinition method)
3794         {
3795                 if (method.IsPrivate && !DocUtils.IsExplicitlyImplemented (method))
3796                         return null;
3797
3798                 var buf = new StringBuilder ();
3799                 buf.Append (".method ");
3800                 AppendVisibility (buf, method);
3801                 if (method.IsStatic)
3802                         buf.Append ("static ");
3803                 if (method.IsHideBySig)
3804                         buf.Append ("hidebysig ");
3805                 if (method.IsPInvokeImpl) {
3806                         var info = method.PInvokeInfo;
3807                         buf.Append ("pinvokeimpl (\"")
3808                                 .Append (info.Module.Name)
3809                                 .Append ("\" as \"")
3810                                 .Append (info.EntryPoint)
3811                                 .Append ("\"");
3812                         if (info.IsCharSetAuto)
3813                                 buf.Append (" auto");
3814                         if (info.IsCharSetUnicode)
3815                                 buf.Append (" unicode");
3816                         if (info.IsCharSetAnsi)
3817                                 buf.Append (" ansi");
3818                         if (info.IsCallConvCdecl)
3819                                 buf.Append (" cdecl");
3820                         if (info.IsCallConvStdCall)
3821                                 buf.Append (" stdcall");
3822                         if (info.IsCallConvWinapi)
3823                                 buf.Append (" winapi");
3824                         if (info.IsCallConvThiscall)
3825                                 buf.Append (" thiscall");
3826                         if (info.SupportsLastError)
3827                                 buf.Append (" lasterr");
3828                         buf.Append (")");
3829                 }
3830                 if (method.IsSpecialName)
3831                         buf.Append ("specialname ");
3832                 if (method.IsRuntimeSpecialName)
3833                         buf.Append ("rtspecialname ");
3834                 if (method.IsNewSlot)
3835                         buf.Append ("newslot ");
3836                 if (method.IsVirtual)
3837                         buf.Append ("virtual ");
3838                 if (!method.IsStatic)
3839                         buf.Append ("instance ");
3840                 _AppendTypeName (buf, method.ReturnType);
3841                 buf.Append (' ')
3842                         .Append (method.Name);
3843                 if (method.IsGenericMethod ()) {
3844                         var state = MemberFormatterState;
3845                         MemberFormatterState = MemberFormatterState.WithinGenericTypeParameters;
3846                         IList<GenericParameter> args = method.GenericParameters;
3847                         if (args.Count > 0) {
3848                                 buf.Append ("<");
3849                                 _AppendTypeName (buf, args [0]);
3850                                 for (int i = 1; i < args.Count; ++i)
3851                                         _AppendTypeName (buf.Append (", "), args [i]);
3852                                 buf.Append (">");
3853                         }
3854                         MemberFormatterState = state;
3855                 }
3856
3857                 buf.Append ('(');
3858                 bool first = true;
3859                 for (int i = 0; i < method.Parameters.Count; ++i) {
3860                         if (!first)
3861                                 buf.Append (", ");
3862                         first = false;
3863                         _AppendTypeName (buf, method.Parameters [i].ParameterType);
3864                         buf.Append (' ');
3865                         buf.Append (method.Parameters [i].Name);
3866                 }
3867                 buf.Append (')');
3868                 if (method.IsIL)
3869                         buf.Append (" cil");
3870                 if (method.IsRuntime)
3871                         buf.Append (" runtime");
3872                 if (method.IsManaged)
3873                         buf.Append (" managed");
3874
3875                 return buf.ToString ();
3876         }
3877
3878         protected override StringBuilder AppendMethodName (StringBuilder buf, MethodDefinition method)
3879         {
3880                 if (DocUtils.IsExplicitlyImplemented (method)) {
3881                         TypeReference iface;
3882                         MethodReference ifaceMethod;
3883                         DocUtils.GetInfoForExplicitlyImplementedMethod (method, out iface, out ifaceMethod);
3884                         return buf.Append (new CSharpMemberFormatter ().GetName (iface))
3885                                 .Append ('.')
3886                                 .Append (ifaceMethod.Name);
3887                 }
3888                 return base.AppendMethodName (buf, method);
3889         }
3890
3891         protected override string RefTypeModifier {
3892                 get {return "";}
3893         }
3894
3895         protected override StringBuilder AppendVisibility (StringBuilder buf, MethodDefinition method)
3896         {
3897                 if (method.IsPublic)
3898                         return buf.Append ("public ");
3899                 if (method.IsFamilyAndAssembly)
3900                         return buf.Append ("familyandassembly");
3901                 if (method.IsFamilyOrAssembly)
3902                         return buf.Append ("familyorassembly");
3903                 if (method.IsFamily)
3904                         return buf.Append ("family");
3905                 return buf;
3906         }
3907
3908         protected override StringBuilder AppendModifiers (StringBuilder buf, MethodDefinition method)
3909         {
3910                 string modifiers = String.Empty;
3911                 if (method.IsStatic) modifiers += " static";
3912                 if (method.IsVirtual && !method.IsAbstract) {
3913                         if ((method.Attributes & MethodAttributes.NewSlot) != 0) modifiers += " virtual";
3914                         else modifiers += " override";
3915                 }
3916                 TypeDefinition declType = (TypeDefinition) method.DeclaringType;
3917                 if (method.IsAbstract && !declType.IsInterface) modifiers += " abstract";
3918                 if (method.IsFinal) modifiers += " sealed";
3919                 if (modifiers == " virtual sealed") modifiers = "";
3920
3921                 return buf.Append (modifiers);
3922         }
3923
3924         protected override StringBuilder AppendGenericMethod (StringBuilder buf, MethodDefinition method)
3925         {
3926                 if (method.IsGenericMethod ()) {
3927                         IList<GenericParameter> args = method.GenericParameters;
3928                         if (args.Count > 0) {
3929                                 buf.Append ("<");
3930                                 buf.Append (args [0].Name);
3931                                 for (int i = 1; i < args.Count; ++i)
3932                                         buf.Append (",").Append (args [i].Name);
3933                                 buf.Append (">");
3934                         }
3935                 }
3936                 return buf;
3937         }
3938
3939         protected override StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters)
3940         {
3941                 return AppendParameters (buf, method, parameters, '(', ')');
3942         }
3943
3944         private StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters, char begin, char end)
3945         {
3946                 buf.Append (begin);
3947
3948                 if (parameters.Count > 0) {
3949                         if (DocUtils.IsExtensionMethod (method))
3950                                 buf.Append ("this ");
3951                         AppendParameter (buf, parameters [0]);
3952                         for (int i = 1; i < parameters.Count; ++i) {
3953                                 buf.Append (", ");
3954                                 AppendParameter (buf, parameters [i]);
3955                         }
3956                 }
3957
3958                 return buf.Append (end);
3959         }
3960
3961         private StringBuilder AppendParameter (StringBuilder buf, ParameterDefinition parameter)
3962         {
3963                 if (parameter.ParameterType is ByReferenceType) {
3964                         if (parameter.IsOut)
3965                                 buf.Append ("out ");
3966                         else
3967                                 buf.Append ("ref ");
3968                 }
3969                 buf.Append (GetName (parameter.ParameterType)).Append (" ");
3970                 return buf.Append (parameter.Name);
3971         }
3972
3973         protected override string GetPropertyDeclaration (PropertyDefinition property)
3974         {
3975                 MethodDefinition gm = null, sm = null;
3976
3977                 string get_visible = null;
3978                 if ((gm = property.GetMethod) != null &&
3979                                 (DocUtils.IsExplicitlyImplemented (gm) ||
3980                                  (!gm.IsPrivate && !gm.IsAssembly && !gm.IsFamilyAndAssembly)))
3981                         get_visible = AppendVisibility (new StringBuilder (), gm).ToString ();
3982                 string set_visible = null;
3983                 if ((sm = property.SetMethod) != null &&
3984                                 (DocUtils.IsExplicitlyImplemented (sm) ||
3985                                  (!sm.IsPrivate && !sm.IsAssembly && !sm.IsFamilyAndAssembly)))
3986                         set_visible = AppendVisibility (new StringBuilder (), sm).ToString ();
3987
3988                 if ((set_visible == null) && (get_visible == null))
3989                         return null;
3990
3991                 StringBuilder buf = new StringBuilder ()
3992                         .Append (".property ");
3993                 if (!(gm ?? sm).IsStatic)
3994                         buf.Append ("instance ");
3995                 _AppendTypeName (buf, property.PropertyType);
3996                 buf.Append (' ').Append (property.Name);
3997                 if (!property.HasParameters || property.Parameters.Count == 0)
3998                         return buf.ToString ();
3999
4000                 buf.Append ('(');
4001                 bool first = true;
4002                 foreach (ParameterDefinition p in property.Parameters) {
4003                         if (!first)
4004                                 buf.Append (", ");
4005                         first = false;
4006                         _AppendTypeName (buf, p.ParameterType);
4007                 }
4008                 buf.Append (')');
4009
4010                 return buf.ToString ();
4011         }
4012
4013         protected override string GetFieldDeclaration (FieldDefinition field)
4014         {
4015                 TypeDefinition declType = (TypeDefinition) field.DeclaringType;
4016                 if (declType.IsEnum && field.Name == "value__")
4017                         return null; // This member of enums aren't documented.
4018
4019                 StringBuilder buf = new StringBuilder ();
4020                 AppendFieldVisibility (buf, field);
4021                 if (buf.Length == 0)
4022                         return null;
4023
4024                 buf.Insert (0, ".field ");
4025
4026                 if (field.IsStatic)
4027                         buf.Append ("static ");
4028                 if (field.IsInitOnly)
4029                         buf.Append ("initonly ");
4030                 if (field.IsLiteral)
4031                         buf.Append ("literal ");
4032                 _AppendTypeName (buf, field.FieldType);
4033                 buf.Append (' ').Append (field.Name);
4034                 AppendFieldValue (buf, field);
4035
4036                 return buf.ToString ();
4037         }
4038
4039         static StringBuilder AppendFieldVisibility (StringBuilder buf, FieldDefinition field)
4040         {
4041                 if (field.IsPublic)
4042                         return buf.Append ("public ");
4043                 if (field.IsFamilyAndAssembly)
4044                         return buf.Append ("familyandassembly ");
4045                 if (field.IsFamilyOrAssembly)
4046                         return buf.Append ("familyorassembly ");
4047                 if (field.IsFamily)
4048                         return buf.Append ("family ");
4049                 return buf;
4050         }
4051
4052         static StringBuilder AppendFieldValue (StringBuilder buf, FieldDefinition field)
4053         {
4054                 // enums have a value__ field, which we ignore
4055                 if (field.DeclaringType.IsGenericType ())
4056                         return buf;
4057                 if (field.HasConstant && field.IsLiteral) {
4058                         object val = null;
4059                         try {
4060                                 val   = field.Constant;
4061                         } catch {
4062                                 return buf;
4063                         }
4064                         if (val == null)
4065                                 buf.Append (" = ").Append ("null");
4066                         else if (val is Enum)
4067                                 buf.Append (" = ")
4068                                         .Append (GetBuiltinType (field.DeclaringType.GetUnderlyingType ().FullName))
4069                                         .Append ('(')
4070                                         .Append (val.ToString ())
4071                                         .Append (')');
4072                         else if (val is IFormattable) {
4073                                 string value = ((IFormattable)val).ToString();
4074                                 buf.Append (" = ");
4075                                 if (val is string)
4076                                         buf.Append ("\"" + value + "\"");
4077                                 else
4078                                         buf.Append (GetBuiltinType (field.DeclaringType.GetUnderlyingType ().FullName))
4079                                                 .Append ('(')
4080                                                 .Append (value)
4081                                                 .Append (')');
4082                         }
4083                 }
4084                 return buf;
4085         }
4086
4087         protected override string GetEventDeclaration (EventDefinition e)
4088         {
4089                 StringBuilder buf = new StringBuilder ();
4090                 if (AppendVisibility (buf, e.AddMethod).Length == 0) {
4091                         return null;
4092                 }
4093
4094                 buf.Length = 0;
4095                 buf.Append (".event ")
4096                         .Append (GetName (e.EventType))
4097                         .Append (' ')
4098                         .Append (e.Name);
4099
4100                 return buf.ToString ();
4101         }
4102 }
4103
4104 class ILMemberFormatter : ILFullMemberFormatter {
4105         protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
4106         {
4107                 return buf;
4108         }
4109 }
4110
4111 class CSharpFullMemberFormatter : MemberFormatter {
4112
4113         public override string Language {
4114                 get {return "C#";}
4115         }
4116
4117         protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
4118         {
4119                 string ns = DocUtils.GetNamespace (type);
4120                 if (GetCSharpType (type.FullName) == null && ns != null && ns.Length > 0 && ns != "System")
4121                         buf.Append (ns).Append ('.');
4122                 return buf;
4123         }
4124
4125         private string GetCSharpType (string t)
4126         {
4127                 switch (t) {
4128                 case "System.Byte":    return "byte";
4129                 case "System.SByte":   return "sbyte";
4130                 case "System.Int16":   return "short";
4131                 case "System.Int32":   return "int";
4132                 case "System.Int64":   return "long";
4133
4134                 case "System.UInt16":  return "ushort";
4135                 case "System.UInt32":  return "uint";
4136                 case "System.UInt64":  return "ulong";
4137
4138                 case "System.Single":  return "float";
4139                 case "System.Double":  return "double";
4140                 case "System.Decimal": return "decimal";
4141                 case "System.Boolean": return "bool";
4142                 case "System.Char":    return "char";
4143                 case "System.Void":    return "void";
4144                 case "System.String":  return "string";
4145                 case "System.Object":  return "object";
4146                 }
4147                 return null;
4148         }
4149
4150         protected override StringBuilder AppendTypeName (StringBuilder buf, TypeReference type)
4151         {
4152                 if (type is GenericParameter)
4153                         return AppendGenericParameterConstraints (buf, (GenericParameter) type).Append (type.Name);
4154                 string t = type.FullName;
4155                 if (!t.StartsWith ("System.")) {
4156                         return base.AppendTypeName (buf, type);
4157                 }
4158
4159                 string s = GetCSharpType (t);
4160                 if (s != null)
4161                         return buf.Append (s);
4162
4163                 return base.AppendTypeName (buf, type);
4164         }
4165
4166         private StringBuilder AppendGenericParameterConstraints (StringBuilder buf, GenericParameter type)
4167         {
4168                 if (MemberFormatterState != MemberFormatterState.WithinGenericTypeParameters)
4169                         return buf;
4170                 GenericParameterAttributes attrs = type.Attributes;
4171                 bool isout = (attrs & GenericParameterAttributes.Covariant) != 0;
4172                 bool isin  = (attrs & GenericParameterAttributes.Contravariant) != 0;
4173                 if (isin)
4174                         buf.Append ("in ");
4175                 else if (isout)
4176                         buf.Append ("out ");
4177                 return buf;
4178         }
4179
4180         protected override string GetTypeDeclaration (TypeDefinition type)
4181         {
4182                 string visibility = GetTypeVisibility (type.Attributes);
4183                 if (visibility == null)
4184                         return null;
4185
4186                 StringBuilder buf = new StringBuilder ();
4187
4188                 buf.Append (visibility);
4189                 buf.Append (" ");
4190
4191                 MemberFormatter full = new CSharpFullMemberFormatter ();
4192
4193                 if (DocUtils.IsDelegate (type)) {
4194                         buf.Append("delegate ");
4195                         MethodDefinition invoke = type.GetMethod ("Invoke");
4196                         buf.Append (full.GetName (invoke.ReturnType)).Append (" ");
4197                         buf.Append (GetName (type));
4198                         AppendParameters (buf, invoke, invoke.Parameters);
4199                         AppendGenericTypeConstraints (buf, type);
4200                         buf.Append (";");
4201
4202                         return buf.ToString();
4203                 }
4204
4205                 if (type.IsAbstract && !type.IsInterface)
4206                         buf.Append("abstract ");
4207                 if (type.IsSealed && !DocUtils.IsDelegate (type) && !type.IsValueType)
4208                         buf.Append("sealed ");
4209                 buf.Replace ("abstract sealed", "static");
4210
4211                 buf.Append (GetTypeKind (type));
4212                 buf.Append (" ");
4213                 buf.Append (GetCSharpType (type.FullName) == null
4214                                 ? GetName (type)
4215                                 : type.Name);
4216
4217                 if (!type.IsEnum) {
4218                         TypeReference basetype = type.BaseType;
4219                         if (basetype != null && basetype.FullName == "System.Object" || type.IsValueType)       // FIXME
4220                                 basetype = null;
4221
4222                         List<string> interface_names = DocUtils.GetUserImplementedInterfaces (type)
4223                                         .Select (iface => full.GetName (iface))
4224                                         .OrderBy (s => s)
4225                                         .ToList ();
4226
4227                         if (basetype != null || interface_names.Count > 0)
4228                                 buf.Append (" : ");
4229
4230                         if (basetype != null) {
4231                                 buf.Append (full.GetName (basetype));
4232                                 if (interface_names.Count > 0)
4233                                         buf.Append (", ");
4234                         }
4235
4236                         for (int i = 0; i < interface_names.Count; i++){
4237                                 if (i != 0)
4238                                         buf.Append (", ");
4239                                 buf.Append (interface_names [i]);
4240                         }
4241                         AppendGenericTypeConstraints (buf, type);
4242                 }
4243
4244                 return buf.ToString ();
4245         }
4246
4247         static string GetTypeKind (TypeDefinition t)
4248         {
4249                 if (t.IsEnum)
4250                         return "enum";
4251                 if (t.IsValueType)
4252                         return "struct";
4253                 if (t.IsClass || t.FullName == "System.Enum")
4254                         return "class";
4255                 if (t.IsInterface)
4256                         return "interface";
4257                 throw new ArgumentException(t.FullName);
4258         }
4259
4260         static string GetTypeVisibility (TypeAttributes ta)
4261         {
4262                 switch (ta & TypeAttributes.VisibilityMask) {
4263                 case TypeAttributes.Public:
4264                 case TypeAttributes.NestedPublic:
4265                         return "public";
4266
4267                 case TypeAttributes.NestedFamily:
4268                 case TypeAttributes.NestedFamORAssem:
4269                         return "protected";
4270
4271                 default:
4272                         return null;
4273                 }
4274         }
4275
4276         protected override StringBuilder AppendGenericTypeConstraints (StringBuilder buf, TypeReference type)
4277         {
4278                 if (type.GenericParameters.Count == 0)
4279                         return buf;
4280                 return AppendConstraints (buf, type.GenericParameters);
4281         }
4282
4283         private StringBuilder AppendConstraints (StringBuilder buf, IList<GenericParameter> genArgs)
4284         {
4285                 foreach (GenericParameter genArg in genArgs) {
4286                         GenericParameterAttributes attrs = genArg.Attributes;
4287                         IList<TypeReference> constraints = genArg.Constraints;
4288                         if (attrs == GenericParameterAttributes.NonVariant && constraints.Count == 0)
4289                                 continue;
4290
4291                         bool isref = (attrs & GenericParameterAttributes.ReferenceTypeConstraint) != 0;
4292                         bool isvt  = (attrs & GenericParameterAttributes.NotNullableValueTypeConstraint) != 0;
4293                         bool isnew = (attrs & GenericParameterAttributes.DefaultConstructorConstraint) != 0;
4294                         bool comma = false;
4295
4296                         if (!isref && !isvt && !isnew && constraints.Count == 0)
4297                                 continue;
4298                         buf.Append (" where ").Append (genArg.Name).Append (" : ");
4299                         if (isref) {
4300                                 buf.Append ("class");
4301                                 comma = true;
4302                         }
4303                         else if (isvt) {
4304                                 buf.Append ("struct");
4305                                 comma = true;
4306                         }
4307                         if (constraints.Count > 0 && !isvt) {
4308                                 if (comma)
4309                                         buf.Append (", ");
4310                                 buf.Append (GetTypeName (constraints [0]));
4311                                 for (int i = 1; i < constraints.Count; ++i)
4312                                         buf.Append (", ").Append (GetTypeName (constraints [i]));
4313                         }
4314                         if (isnew && !isvt) {
4315                                 if (comma)
4316                                         buf.Append (", ");
4317                                 buf.Append ("new()");
4318                         }
4319                 }
4320                 return buf;
4321         }
4322
4323         protected override string GetConstructorDeclaration (MethodDefinition constructor)
4324         {
4325                 StringBuilder buf = new StringBuilder ();
4326                 AppendVisibility (buf, constructor);
4327                 if (buf.Length == 0)
4328                         return null;
4329
4330                 buf.Append (' ');
4331                 base.AppendTypeName (buf, constructor.DeclaringType.Name).Append (' ');
4332                 AppendParameters (buf, constructor, constructor.Parameters);
4333                 buf.Append (';');
4334
4335                 return buf.ToString ();
4336         }
4337
4338         protected override string GetMethodDeclaration (MethodDefinition method)
4339         {
4340                 string decl = base.GetMethodDeclaration (method);
4341                 if (decl != null)
4342                         return decl + ";";
4343                 return null;
4344         }
4345
4346         protected override string GetTypeName (MethodReturnType returnType)
4347         {
4348                 return GetTypeName (returnType, () => returnType.ReturnType);
4349         }
4350
4351         string GetTypeName (ICustomAttributeProvider provider, Func<TypeReference> selector)
4352         {
4353                 string type = GetName (selector ());
4354                 if (type == "object" && provider.HasCustomAttributes &&
4355                                 provider.CustomAttributes.Cast<CustomAttribute>()
4356                                 .Any (ca => ca.Constructor.DeclaringType.FullName == "System.Runtime.CompilerServices.DynamicAttribute"))
4357                         return "dynamic";
4358                 return type;
4359         }
4360
4361         protected override StringBuilder AppendMethodName (StringBuilder buf, MethodDefinition method)
4362         {
4363                 if (DocUtils.IsExplicitlyImplemented (method)) {
4364                         TypeReference iface;
4365                         MethodReference ifaceMethod;
4366                         DocUtils.GetInfoForExplicitlyImplementedMethod (method, out iface, out ifaceMethod);
4367                         return buf.Append (new CSharpMemberFormatter ().GetName (iface))
4368                                 .Append ('.')
4369                                 .Append (ifaceMethod.Name);
4370                 }
4371                 return base.AppendMethodName (buf, method);
4372         }
4373
4374         protected override StringBuilder AppendGenericMethodConstraints (StringBuilder buf, MethodDefinition method)
4375         {
4376                 if (method.GenericParameters.Count == 0)
4377                         return buf;
4378                 return AppendConstraints (buf, method.GenericParameters);
4379         }
4380
4381         protected override string RefTypeModifier {
4382                 get {return "";}
4383         }
4384
4385         protected override string GetFinalizerName (MethodDefinition method)
4386         {
4387                 return "~" + method.DeclaringType.Name + " ()";
4388         }
4389
4390         protected override StringBuilder AppendVisibility (StringBuilder buf, MethodDefinition method)
4391         {
4392                 if (method == null)
4393                         return buf;
4394                 if (method.IsPublic)
4395                         return buf.Append ("public");
4396                 if (method.IsFamily || method.IsFamilyOrAssembly)
4397                         return buf.Append ("protected");
4398                 return buf;
4399         }
4400
4401         protected override StringBuilder AppendModifiers (StringBuilder buf, MethodDefinition method)
4402         {
4403                 string modifiers = String.Empty;
4404                 if (method.IsStatic) modifiers += " static";
4405                 if (method.IsVirtual && !method.IsAbstract) {
4406                         if ((method.Attributes & MethodAttributes.NewSlot) != 0) modifiers += " virtual";
4407                         else modifiers += " override";
4408                 }
4409                 TypeDefinition declType = (TypeDefinition) method.DeclaringType;
4410                 if (method.IsAbstract && !declType.IsInterface) modifiers += " abstract";
4411                 if (method.IsFinal) modifiers += " sealed";
4412                 if (modifiers == " virtual sealed") modifiers = "";
4413
4414                 return buf.Append (modifiers);
4415         }
4416
4417         protected override StringBuilder AppendGenericMethod (StringBuilder buf, MethodDefinition method)
4418         {
4419                 if (method.IsGenericMethod ()) {
4420                         IList<GenericParameter> args = method.GenericParameters;
4421                         if (args.Count > 0) {
4422                                 buf.Append ("<");
4423                                 buf.Append (args [0].Name);
4424                                 for (int i = 1; i < args.Count; ++i)
4425                                         buf.Append (",").Append (args [i].Name);
4426                                 buf.Append (">");
4427                         }
4428                 }
4429                 return buf;
4430         }
4431
4432         protected override StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters)
4433         {
4434                 return AppendParameters (buf, method, parameters, '(', ')');
4435         }
4436
4437         private StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters, char begin, char end)
4438         {
4439                 buf.Append (begin);
4440
4441                 if (parameters.Count > 0) {
4442                         if (DocUtils.IsExtensionMethod (method))
4443                                 buf.Append ("this ");
4444                         AppendParameter (buf, parameters [0]);
4445                         for (int i = 1; i < parameters.Count; ++i) {
4446                                 buf.Append (", ");
4447                                 AppendParameter (buf, parameters [i]);
4448                         }
4449                 }
4450
4451                 return buf.Append (end);
4452         }
4453
4454         private StringBuilder AppendParameter (StringBuilder buf, ParameterDefinition parameter)
4455         {
4456                 if (parameter.ParameterType is ByReferenceType) {
4457                         if (parameter.IsOut)
4458                                 buf.Append ("out ");
4459                         else
4460                                 buf.Append ("ref ");
4461                 }
4462                 buf.Append (GetTypeName (parameter, () => parameter.ParameterType)).Append (" ");
4463                 return buf.Append (parameter.Name);
4464         }
4465
4466         protected override string GetPropertyDeclaration (PropertyDefinition property)
4467         {
4468                 MethodDefinition method;
4469
4470                 string get_visible = null;
4471                 if ((method = property.GetMethod) != null &&
4472                                 (DocUtils.IsExplicitlyImplemented (method) ||
4473                                  (!method.IsPrivate && !method.IsAssembly && !method.IsFamilyAndAssembly)))
4474                         get_visible = AppendVisibility (new StringBuilder (), method).ToString ();
4475                 string set_visible = null;
4476                 if ((method = property.SetMethod) != null &&
4477                                 (DocUtils.IsExplicitlyImplemented (method) ||
4478                                  (!method.IsPrivate && !method.IsAssembly && !method.IsFamilyAndAssembly)))
4479                         set_visible = AppendVisibility (new StringBuilder (), method).ToString ();
4480
4481                 if ((set_visible == null) && (get_visible == null))
4482                         return null;
4483
4484                 string visibility;
4485                 StringBuilder buf = new StringBuilder ();
4486                 if (get_visible != null && (set_visible == null || (set_visible != null && get_visible == set_visible)))
4487                         buf.Append (visibility = get_visible);
4488                 else if (set_visible != null && get_visible == null)
4489                         buf.Append (visibility = set_visible);
4490                 else
4491                         buf.Append (visibility = "public");
4492
4493                 // Pick an accessor to use for static/virtual/override/etc. checks.
4494                 method = property.SetMethod;
4495                 if (method == null)
4496                         method = property.GetMethod;
4497
4498                 string modifiers = String.Empty;
4499                 if (method.IsStatic) modifiers += " static";
4500                 if (method.IsVirtual && !method.IsAbstract) {
4501                                 if ((method.Attributes & MethodAttributes.NewSlot) != 0)
4502                                         modifiers += " virtual";
4503                                 else
4504                                         modifiers += " override";
4505                 }
4506                 TypeDefinition declDef = (TypeDefinition) method.DeclaringType;
4507                 if (method.IsAbstract && !declDef.IsInterface)
4508                         modifiers += " abstract";
4509                 if (method.IsFinal)
4510                         modifiers += " sealed";
4511                 if (modifiers == " virtual sealed")
4512                         modifiers = "";
4513                 buf.Append (modifiers).Append (' ');
4514
4515                 buf.Append (GetName (property.PropertyType)).Append (' ');
4516
4517                 IEnumerable<MemberReference> defs = property.DeclaringType.GetDefaultMembers ();
4518                 string name = property.Name;
4519                 foreach (MemberReference mi in defs) {
4520                         if (mi == property) {
4521                                 name = "this";
4522                                 break;
4523                         }
4524                 }
4525                 buf.Append (name == "this" ? name : DocUtils.GetPropertyName (property));
4526
4527                 if (property.Parameters.Count != 0) {
4528                         AppendParameters (buf, method, property.Parameters, '[', ']');
4529                 }
4530
4531                 buf.Append (" {");
4532                 if (get_visible != null) {
4533                         if (get_visible != visibility)
4534                                 buf.Append (' ').Append (get_visible);
4535                         buf.Append (" get;");
4536                 }
4537                 if (set_visible != null) {
4538                         if (set_visible != visibility)
4539                                 buf.Append (' ').Append (set_visible);
4540                         buf.Append (" set;");
4541                 }
4542                 buf.Append (" }");
4543
4544                 return buf [0] != ' ' ? buf.ToString () : buf.ToString (1, buf.Length-1);
4545         }
4546
4547         protected override string GetFieldDeclaration (FieldDefinition field)
4548         {
4549                 TypeDefinition declType = (TypeDefinition) field.DeclaringType;
4550                 if (declType.IsEnum && field.Name == "value__")
4551                         return null; // This member of enums aren't documented.
4552
4553                 StringBuilder buf = new StringBuilder ();
4554                 AppendFieldVisibility (buf, field);
4555                 if (buf.Length == 0)
4556                         return null;
4557
4558                 if (declType.IsEnum)
4559                         return field.Name;
4560
4561                 if (field.IsStatic && !field.IsLiteral)
4562                         buf.Append (" static");
4563                 if (field.IsInitOnly)
4564                         buf.Append (" readonly");
4565                 if (field.IsLiteral)
4566                         buf.Append (" const");
4567
4568                 buf.Append (' ').Append (GetName (field.FieldType)).Append (' ');
4569                 buf.Append (field.Name);
4570                 AppendFieldValue (buf, field);
4571                 buf.Append (';');
4572
4573                 return buf.ToString ();
4574         }
4575
4576         static StringBuilder AppendFieldVisibility (StringBuilder buf, FieldDefinition field)
4577         {
4578                 if (field.IsPublic)
4579                         return buf.Append ("public");
4580                 if (field.IsFamily || field.IsFamilyOrAssembly)
4581                         return buf.Append ("protected");
4582                 return buf;
4583         }
4584
4585         static StringBuilder AppendFieldValue (StringBuilder buf, FieldDefinition field)
4586         {
4587                 // enums have a value__ field, which we ignore
4588                 if (((TypeDefinition ) field.DeclaringType).IsEnum ||
4589                                 field.DeclaringType.IsGenericType ())
4590                         return buf;
4591                 if (field.HasConstant && field.IsLiteral) {
4592                         object val = null;
4593                         try {
4594                                 val   = field.Constant;
4595                         } catch {
4596                                 return buf;
4597                         }
4598                         if (val == null)
4599                                 buf.Append (" = ").Append ("null");
4600                         else if (val is Enum)
4601                                 buf.Append (" = ").Append (val.ToString ());
4602                         else if (val is IFormattable) {
4603                                 string value = ((IFormattable)val).ToString();
4604                                 if (val is string)
4605                                         value = "\"" + value + "\"";
4606                                 buf.Append (" = ").Append (value);
4607                         }
4608                 }
4609                 return buf;
4610         }
4611
4612         protected override string GetEventDeclaration (EventDefinition e)
4613         {
4614                 StringBuilder buf = new StringBuilder ();
4615                 if (AppendVisibility (buf, e.AddMethod).Length == 0) {
4616                         return null;
4617                 }
4618
4619                 AppendModifiers (buf, e.AddMethod);
4620
4621                 buf.Append (" event ");
4622                 buf.Append (GetName (e.EventType)).Append (' ');
4623                 buf.Append (e.Name).Append (';');
4624
4625                 return buf.ToString ();
4626         }
4627 }
4628
4629 class CSharpMemberFormatter : CSharpFullMemberFormatter {
4630         protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
4631         {
4632                 return buf;
4633         }
4634 }
4635
4636 class DocTypeFullMemberFormatter : MemberFormatter {
4637         public static readonly MemberFormatter Default = new DocTypeFullMemberFormatter ();
4638
4639         protected override char NestedTypeSeparator {
4640                 get {return '+';}
4641         }
4642 }
4643
4644 class DocTypeMemberFormatter : DocTypeFullMemberFormatter {
4645         protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
4646         {
4647                 return buf;
4648         }
4649 }
4650
4651 class SlashDocMemberFormatter : MemberFormatter {
4652
4653         protected override char[] GenericTypeContainer {
4654                 get {return new char[]{'{', '}'};}
4655         }
4656
4657         private bool AddTypeCount = true;
4658
4659         private TypeReference genDeclType;
4660         private MethodReference genDeclMethod;
4661
4662         protected override StringBuilder AppendTypeName (StringBuilder buf, TypeReference type)
4663         {
4664                 if (type is GenericParameter) {
4665                         int l = buf.Length;
4666                         if (genDeclType != null) {
4667                                 IList<GenericParameter> genArgs = genDeclType.GenericParameters;
4668                                 for (int i = 0; i < genArgs.Count; ++i) {
4669                                         if (genArgs [i].Name == type.Name) {
4670                                                 buf.Append ('`').Append (i);
4671                                                 break;
4672                                         }
4673                                 }
4674                         }
4675                         if (genDeclMethod != null) {
4676                                 IList<GenericParameter> genArgs = null;
4677                                 if (genDeclMethod.IsGenericMethod ()) {
4678                                         genArgs = genDeclMethod.GenericParameters;
4679                                         for (int i = 0; i < genArgs.Count; ++i) {
4680                                                 if (genArgs [i].Name == type.Name) {
4681                                                         buf.Append ("``").Append (i);
4682                                                         break;
4683                                                 }
4684                                         }
4685                                 }
4686                         }
4687                         if (genDeclType == null && genDeclMethod == null) {
4688                                 // Probably from within an explicitly implemented interface member,
4689                                 // where CSC uses parameter names instead of indices (why?), e.g.
4690                                 // MyList`2.Mono#DocTest#Generic#IFoo{A}#Method``1(`0,``0) instead of
4691                                 // MyList`2.Mono#DocTest#Generic#IFoo{`0}#Method``1(`0,``0).
4692                                 buf.Append (type.Name);
4693                         }
4694                         if (buf.Length == l) {
4695                                 throw new Exception (string.Format (
4696                                                 "Unable to translate generic parameter {0}; genDeclType={1}, genDeclMethod={2}",
4697                                                 type.Name, genDeclType, genDeclMethod));
4698                         }
4699                 }
4700                 else {
4701                         base.AppendTypeName (buf, type);
4702                         if (AddTypeCount) {
4703                                 int numArgs = type.GenericParameters.Count;
4704                                 if (type.DeclaringType != null)
4705                                         numArgs -= type.GenericParameters.Count;
4706                                 if (numArgs > 0) {
4707                                         buf.Append ('`').Append (numArgs);
4708                                 }
4709                         }
4710                 }
4711                 return buf;
4712         }
4713
4714         protected override StringBuilder AppendGenericType (StringBuilder buf, TypeReference type)
4715         {
4716                 if (!AddTypeCount)
4717                         base.AppendGenericType (buf, type);
4718                 else
4719                         AppendType (buf, type);
4720                 return buf;
4721         }
4722
4723         private StringBuilder AppendType (StringBuilder buf, TypeReference type)
4724         {
4725                 List<TypeReference> decls = DocUtils.GetDeclaringTypes (type);
4726                 bool insertNested = false;
4727                 int prevParamCount = 0;
4728                 foreach (var decl in decls) {
4729                         if (insertNested)
4730                                 buf.Append (NestedTypeSeparator);
4731                         insertNested = true;
4732                         base.AppendTypeName (buf, decl);
4733                         int argCount = DocUtils.GetGenericArgumentCount (decl);
4734                         int numArgs = argCount - prevParamCount;
4735                         prevParamCount = argCount;
4736                         if (numArgs > 0)
4737                                 buf.Append ('`').Append (numArgs);
4738                 }
4739                 return buf;
4740         }
4741
4742         public override string GetDeclaration (MemberReference member)
4743         {
4744                 TypeReference r = member as TypeReference;
4745                 if (r != null) {
4746                         return "T:" + GetTypeName (r);
4747                 }
4748                 return base.GetDeclaration (member);
4749         }
4750
4751         protected override string GetConstructorName (MethodReference constructor)
4752         {
4753                 return GetMethodDefinitionName (constructor, "#ctor");
4754         }
4755
4756         protected override string GetMethodName (MethodReference method)
4757         {
4758                 string name = null;
4759                 MethodDefinition methodDef = method as MethodDefinition;
4760                 if (methodDef == null || !DocUtils.IsExplicitlyImplemented (methodDef))
4761                         name = method.Name;
4762                 else {
4763                         TypeReference iface;
4764                         MethodReference ifaceMethod;
4765                         DocUtils.GetInfoForExplicitlyImplementedMethod (methodDef, out iface, out ifaceMethod);
4766                         AddTypeCount = false;
4767                         name = GetTypeName (iface) + "." + ifaceMethod.Name;
4768                         AddTypeCount = true;
4769                 }
4770                 return GetMethodDefinitionName (method, name);
4771         }
4772
4773         private string GetMethodDefinitionName (MethodReference method, string name)
4774         {
4775                 StringBuilder buf = new StringBuilder ();
4776                 buf.Append (GetTypeName (method.DeclaringType));
4777                 buf.Append ('.');
4778                 buf.Append (name.Replace (".", "#"));
4779                 if (method.IsGenericMethod ()) {
4780                         IList<GenericParameter> genArgs = method.GenericParameters;
4781                         if (genArgs.Count > 0)
4782                                 buf.Append ("``").Append (genArgs.Count);
4783                 }
4784                 IList<ParameterDefinition> parameters = method.Parameters;
4785                 try {
4786                         genDeclType   = method.DeclaringType;
4787                         genDeclMethod = method;
4788                         AppendParameters (buf, method.DeclaringType.GenericParameters, parameters);
4789                 }
4790                 finally {
4791                         genDeclType   = null;
4792                         genDeclMethod = null;
4793                 }
4794                 return buf.ToString ();
4795         }
4796
4797         private StringBuilder AppendParameters (StringBuilder buf, IList<GenericParameter> genArgs, IList<ParameterDefinition> parameters)
4798         {
4799                 if (parameters.Count == 0)
4800                         return buf;
4801
4802                 buf.Append ('(');
4803
4804                 AppendParameter (buf, genArgs, parameters [0]);
4805                 for (int i = 1; i < parameters.Count; ++i) {
4806                         buf.Append (',');
4807                         AppendParameter (buf, genArgs, parameters [i]);
4808                 }
4809
4810                 return buf.Append (')');
4811         }
4812
4813         private StringBuilder AppendParameter (StringBuilder buf, IList<GenericParameter> genArgs, ParameterDefinition parameter)
4814         {
4815                 AddTypeCount = false;
4816                 buf.Append (GetTypeName (parameter.ParameterType));
4817                 AddTypeCount = true;
4818                 return buf;
4819         }
4820
4821         protected override string GetPropertyName (PropertyReference property)
4822         {
4823                 string name = null;
4824
4825                 PropertyDefinition propertyDef = property as PropertyDefinition;
4826                 MethodDefinition method = null;
4827                 if (propertyDef != null)
4828                         method = propertyDef.GetMethod ?? propertyDef.SetMethod;
4829                 if (method != null && !DocUtils.IsExplicitlyImplemented (method))
4830                         name = property.Name;
4831                 else {
4832                         TypeReference iface;
4833                         MethodReference ifaceMethod;
4834                         DocUtils.GetInfoForExplicitlyImplementedMethod (method, out iface, out ifaceMethod);
4835                         AddTypeCount = false;
4836                         name = string.Join ("#", new string[]{
4837                                         GetTypeName (iface).Replace (".", "#"),
4838                                         DocUtils.GetMember (property.Name)
4839                         });
4840                         AddTypeCount = true;
4841                 }
4842
4843                 StringBuilder buf = new StringBuilder ();
4844                 buf.Append (GetName (property.DeclaringType));
4845                 buf.Append ('.');
4846                 buf.Append (name);
4847                 IList<ParameterDefinition> parameters = property.Parameters;
4848                 if (parameters.Count > 0) {
4849                         genDeclType = property.DeclaringType;
4850                         buf.Append ('(');
4851                         IList<GenericParameter> genArgs = property.DeclaringType.GenericParameters;
4852                         AppendParameter (buf, genArgs, parameters [0]);
4853                         for (int i = 1; i < parameters.Count; ++i) {
4854                                  buf.Append (',');
4855                                  AppendParameter (buf, genArgs, parameters [i]);
4856                         }
4857                         buf.Append (')');
4858                         genDeclType = null;
4859                 }
4860                 return buf.ToString ();
4861         }
4862
4863         protected override string GetFieldName (FieldReference field)
4864         {
4865                 return string.Format ("{0}.{1}",
4866                         GetName (field.DeclaringType), field.Name);
4867         }
4868
4869         protected override string GetEventName (EventReference e)
4870         {
4871                 return string.Format ("{0}.{1}",
4872                         GetName (e.DeclaringType), e.Name);
4873         }
4874
4875         protected override string GetTypeDeclaration (TypeDefinition type)
4876         {
4877                 string name = GetName (type);
4878                 if (type == null)
4879                         return null;
4880                 return "T:" + name;
4881         }
4882
4883         protected override string GetConstructorDeclaration (MethodDefinition constructor)
4884         {
4885                 string name = GetName (constructor);
4886                 if (name == null)
4887                         return null;
4888                 return "M:" + name;
4889         }
4890
4891         protected override string GetMethodDeclaration (MethodDefinition method)
4892         {
4893                 string name = GetName (method);
4894                 if (name == null)
4895                         return null;
4896                 if (method.Name == "op_Implicit" || method.Name == "op_Explicit") {
4897                         genDeclType = method.DeclaringType;
4898                         genDeclMethod = method;
4899                         name += "~" + GetName (method.ReturnType);
4900                         genDeclType = null;
4901                         genDeclMethod = null;
4902                 }
4903                 return "M:" + name;
4904         }
4905
4906         protected override string GetPropertyDeclaration (PropertyDefinition property)
4907         {
4908                 string name = GetName (property);
4909                 if (name == null)
4910                         return null;
4911                 return "P:" + name;
4912         }
4913
4914         protected override string GetFieldDeclaration (FieldDefinition field)
4915         {
4916                 string name = GetName (field);
4917                 if (name == null)
4918                         return null;
4919                 return "F:" + name;
4920         }
4921
4922         protected override string GetEventDeclaration (EventDefinition e)
4923         {
4924                 string name = GetName (e);
4925                 if (name == null)
4926                         return null;
4927                 return "E:" + name;
4928         }
4929 }
4930
4931 class FileNameMemberFormatter : SlashDocMemberFormatter {
4932         protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
4933         {
4934                 return buf;
4935         }
4936
4937         protected override char NestedTypeSeparator {
4938                 get {return '+';}
4939         }
4940 }
4941
4942 }