using System;
using System.Collections;
using System.Collections.Generic;
+using System.Collections.ObjectModel;
using System.Diagnostics;
using System.Globalization;
using System.IO;
bool delete;
bool show_exceptions;
- bool no_assembly_versions;
+ bool no_assembly_versions, ignore_missing_types;
ExceptionLocations? exceptions;
- int additions = 0, deletions = 0;
+ internal int additions = 0, deletions = 0;
- static XmlDocument slashdocs;
- XmlReader ecmadocs;
+ List<DocumentationImporter> importers = new List<DocumentationImporter> ();
+
+ DocumentationEnumerator docEnum;
string since;
- static readonly MemberFormatter csharpFullFormatter = new CSharpFullMemberFormatter ();
- static readonly MemberFormatter csharpFormatter = new CSharpMemberFormatter ();
static readonly MemberFormatter docTypeFormatter = new DocTypeMemberFormatter ();
- static readonly MemberFormatter slashdocFormatter = new SlashDocMemberFormatter ();
static readonly MemberFormatter filenameFormatter = new FileNameMemberFormatter ();
+ static MemberFormatter[] typeFormatters = new MemberFormatter[]{
+ new CSharpMemberFormatter (),
+ new ILMemberFormatter (),
+ };
+
+ static MemberFormatter[] memberFormatters = new MemberFormatter[]{
+ new CSharpFullMemberFormatter (),
+ new ILFullMemberFormatter (),
+ };
+
+ internal static readonly MemberFormatter slashdocFormatter = new SlashDocMemberFormatter ();
+
MyXmlNodeList extensionMethods = new MyXmlNodeList ();
+ HashSet<string> forwardedTypes = new HashSet<string> ();
+
public override void Run (IEnumerable<string> args)
{
show_exceptions = DebugOutput;
- string import = null;
var types = new List<string> ();
var p = new OptionSet () {
{ "delete",
" asm Method calls in same assembly\n" +
" depasm Method calls in dependent assemblies\n" +
" all Record all possible exceptions\n" +
+ " added Modifier; only create <exception/>s\n" +
+ " for NEW types/members\n" +
"If nothing is specified, then only exceptions from the member will " +
"be listed.",
v => exceptions = ParseExceptionLocations (v) },
"Specify a {FLAG} to alter behavior. See later -f* options for available flags.",
v => {
switch (v) {
+ case "ignore-missing-types":
+ ignore_missing_types = true;
+ break;
case "no-assembly-versions":
no_assembly_versions = true;
break;
throw new Exception ("Unsupported flag `" + v + "'.");
}
} },
+ { "fignore-missing-types",
+ "Do not report an error if a --type=TYPE type\nwas not found.",
+ v => ignore_missing_types = v != null },
{ "fno-assembly-versions",
"Do not generate //AssemblyVersion elements.",
v => no_assembly_versions = v != null },
{ "i|import=",
"Import documentation from {FILE}.",
- v => import = v },
+ v => AddImporter (v) },
{ "L|lib=",
"Check for assembly references in {DIRECTORY}.",
v => assemblyResolver.AddSearchDirectory (v) },
+ { "library=",
+ "Ignored for compatibility with update-ecma-xml.",
+ v => {} },
{ "o|out=",
"Root {DIRECTORY} to generate/update documentation.",
v => srcPath = v },
this.assemblies = assemblies.Select (a => LoadAssembly (a)).ToList ();
- if (import != null && ecmadocs == null && slashdocs == null) {
- try {
- XmlReader r = new XmlTextReader (import);
- if (r.Read ()) {
- while (r.NodeType != XmlNodeType.Element) {
- if (!r.Read ())
- Error ("Unable to read XML file: {0}.", import);
- }
- if (r.LocalName == "doc") {
- var xml = File.ReadAllText (import);
- // Ensure Unix line endings
- xml = xml.Replace ("\r", "");
- slashdocs = new XmlDocument();
- slashdocs.LoadXml (xml);
- }
- else if (r.LocalName == "Libraries") {
- ecmadocs = new XmlTextReader (import);
- }
- else
- Error ("Unsupported XML format within {0}.", import);
- }
- r.Close ();
- } catch (Exception e) {
- Environment.ExitCode = 1;
- Error ("Could not load XML file: {0}.", e.Message);
- }
- }
+ // Store types that have been forwarded to avoid duplicate generation
+ GatherForwardedTypes ();
+
+ docEnum = docEnum ?? new DocumentationEnumerator ();
// PERFORM THE UPDATES
- if (types.Count > 0)
+ if (types.Count > 0) {
+ types.Sort ();
DoUpdateTypes (srcPath, types, srcPath);
+ }
#if false
else if (opts.@namespace != null)
DoUpdateNS (opts.@namespace, Path.Combine (opts.path, opts.@namespace),
Console.WriteLine("Members Added: {0}, Members Deleted: {1}", additions, deletions);
}
+ void AddImporter (string path)
+ {
+ try {
+ XmlReader r = new XmlTextReader (path);
+ if (r.Read ()) {
+ while (r.NodeType != XmlNodeType.Element) {
+ if (!r.Read ())
+ Error ("Unable to read XML file: {0}.", path);
+ }
+ if (r.LocalName == "doc") {
+ importers.Add (new MsxdocDocumentationImporter (path));
+ }
+ else if (r.LocalName == "Libraries") {
+ var ecmadocs = new XmlTextReader (path);
+ docEnum = new EcmaDocumentationEnumerator (this, ecmadocs);
+ importers.Add (new EcmaDocumentationImporter (ecmadocs));
+ }
+ else
+ Error ("Unsupported XML format within {0}.", path);
+ }
+ r.Close ();
+ } catch (Exception e) {
+ Environment.ExitCode = 1;
+ Error ("Could not load XML file: {0}.", e.Message);
+ }
+ }
+
+ void GatherForwardedTypes ()
+ {
+ foreach (var asm in assemblies)
+ foreach (var type in asm.MainModule.ExportedTypes.Where (t => t.IsForwarder).Select (t => t.FullName))
+ forwardedTypes.Add (type);
+ }
+
static ExceptionLocations ParseExceptionLocations (string s)
{
ExceptionLocations loc = ExceptionLocations.Member;
return loc;
}
- private void Warning (string format, params object[] args)
+ internal void Warning (string format, params object[] args)
{
Message (TraceLevel.Warning, "mdoc: " + format, args);
}
{
AssemblyDefinition assembly = null;
try {
- assembly = AssemblyFactory.GetAssembly (name);
+ assembly = AssemblyDefinition.ReadAssembly (name, new ReaderParameters { AssemblyResolver = assemblyResolver });
} catch (System.IO.FileNotFoundException) { }
if (assembly == null)
throw new InvalidOperationException("Assembly " + name + " not found.");
- assembly.Resolver = assemblyResolver;
return assembly;
}
public void DoUpdateTypes (string basepath, List<string> typenames, string dest)
{
+ var index = CreateIndexForTypes (dest);
+
var found = new HashSet<string> ();
foreach (AssemblyDefinition assembly in assemblies) {
- foreach (DocsTypeInfo docsTypeInfo in GetTypes (assembly, typenames)) {
- string relpath = DoUpdateType (docsTypeInfo.Type, basepath, dest, docsTypeInfo.EcmaDocs);
- if (relpath != null)
- found.Add (docsTypeInfo.Type.FullName);
+ foreach (TypeDefinition type in docEnum.GetDocumentationTypes (assembly, typenames)) {
+ string relpath = DoUpdateType (type, basepath, dest);
+ if (relpath == null)
+ continue;
+
+ found.Add (type.FullName);
+
+ if (index == null)
+ continue;
+
+ index.Add (assembly);
+ index.Add (type);
}
}
+
+ if (index != null)
+ index.Write ();
+
+ if (ignore_missing_types)
+ return;
+
var notFound = from n in typenames where !found.Contains (n) select n;
if (notFound.Any ())
throw new InvalidOperationException("Type(s) not found: " + string.Join (", ", notFound.ToArray ()));
}
- public string DoUpdateType (TypeDefinition type, string basepath, string dest, XmlReader ecmaDocsType)
+ class IndexForTypes {
+
+ MDocUpdater app;
+ string indexFile;
+
+ XmlDocument index;
+ XmlElement index_types;
+ XmlElement index_assemblies;
+
+ public IndexForTypes (MDocUpdater app, string indexFile, XmlDocument index)
+ {
+ this.app = app;
+ this.indexFile = indexFile;
+ this.index = index;
+
+ index_types = WriteElement (index.DocumentElement, "Types");
+ index_assemblies = WriteElement (index.DocumentElement, "Assemblies");
+ }
+
+ public void Add (AssemblyDefinition assembly)
+ {
+ if (index_assemblies.SelectSingleNode ("Assembly[@Name='" + assembly.Name.Name + "']") != null)
+ return;
+
+ app.AddIndexAssembly (assembly, index_assemblies);
+ }
+
+ public void Add (TypeDefinition type)
+ {
+ app.AddIndexType (type, index_types);
+ }
+
+ public void Write ()
+ {
+ SortIndexEntries (index_types);
+ WriteFile (indexFile, FileMode.Create,
+ writer => WriteXml (index.DocumentElement, writer));
+ }
+ }
+
+ IndexForTypes CreateIndexForTypes (string dest)
+ {
+ string indexFile = Path.Combine (dest, "index.xml");
+ if (File.Exists (indexFile))
+ return null;
+ return new IndexForTypes (this, indexFile, CreateIndexStub ());
+ }
+
+ public string DoUpdateType (TypeDefinition type, string basepath, string dest)
{
if (type.Namespace == null)
Warning ("warning: The type `{0}' is in the root namespace. This may cause problems with display within monodoc.",
throw new InvalidOperationException("Error loading " + typefile + ": " + e.Message, e);
}
- DoUpdateType2("Updating", basefile, type, output, false, ecmaDocsType);
+ DoUpdateType2("Updating", basefile, type, output, false);
} else {
// Stub
- XmlElement td = StubType(type, output, ecmaDocsType);
+ XmlElement td = StubType(type, output);
if (td == null)
return null;
}
seenTypes[type] = seenTypes;
- DoUpdateType2("Updating", basefile, type, Path.Combine(outpath, file.Name), false, null);
+ DoUpdateType2("Updating", basefile, type, Path.Combine(outpath, file.Name), false);
}
// Stub types not in the directory
- foreach (DocsTypeInfo docsTypeInfo in GetTypes (assembly, null)) {
- TypeDefinition type = docsTypeInfo.Type;
+ foreach (TypeDefinition type in docEnum.GetDocumentationTypes (assembly, null)) {
if (type.Namespace != ns || seenTypes.ContainsKey(type))
continue;
- XmlElement td = StubType(type, Path.Combine(outpath, GetTypeFileName(type) + ".xml"), docsTypeInfo.EcmaDocs);
+ XmlElement td = StubType(type, Path.Combine(outpath, GetTypeFileName(type) + ".xml"));
if (td == null) continue;
}
}
XmlElement index_assembly = parent.OwnerDocument.CreateElement("Assembly");
index_assembly.SetAttribute ("Name", assembly.Name.Name);
index_assembly.SetAttribute ("Version", assembly.Name.Version.ToString());
- MakeAttributes (index_assembly, assembly.CustomAttributes, 0);
+
+ AssemblyNameDefinition name = assembly.Name;
+ if (name.HasPublicKey) {
+ XmlElement pubkey = parent.OwnerDocument.CreateElement ("AssemblyPublicKey");
+ var key = new StringBuilder (name.PublicKey.Length*3 + 2);
+ key.Append ("[");
+ foreach (byte b in name.PublicKey)
+ key.AppendFormat ("{0,2:x2} ", b);
+ key.Append ("]");
+ pubkey.InnerText = key.ToString ();
+ index_assembly.AppendChild (pubkey);
+ }
+
+ if (!string.IsNullOrEmpty (name.Culture)) {
+ XmlElement culture = parent.OwnerDocument.CreateElement ("AssemblyCulture");
+ culture.InnerText = name.Culture;
+ index_assembly.AppendChild (culture);
+ }
+
+ MakeAttributes (index_assembly, GetCustomAttributes (assembly.CustomAttributes, ""));
parent.AppendChild(index_assembly);
}
+ private void AddIndexType (TypeDefinition type, XmlElement index_types)
+ {
+ string typename = GetTypeFileName(type);
+
+ // Add namespace and type nodes into the index file as needed
+ string ns = DocUtils.GetNamespace (type);
+ XmlElement nsnode = (XmlElement) index_types.SelectSingleNode ("Namespace[@Name='" + ns + "']");
+ if (nsnode == null) {
+ nsnode = index_types.OwnerDocument.CreateElement("Namespace");
+ nsnode.SetAttribute ("Name", ns);
+ index_types.AppendChild (nsnode);
+ }
+ string doc_typename = GetDocTypeName (type);
+ XmlElement typenode = (XmlElement) nsnode.SelectSingleNode ("Type[@Name='" + typename + "']");
+ if (typenode == null) {
+ typenode = index_types.OwnerDocument.CreateElement ("Type");
+ typenode.SetAttribute ("Name", typename);
+ nsnode.AppendChild (typenode);
+ }
+ if (typename != doc_typename)
+ typenode.SetAttribute("DisplayName", doc_typename);
+ else
+ typenode.RemoveAttribute("DisplayName");
+
+ typenode.SetAttribute ("Kind", GetTypeKind (type));
+ }
+
private void DoUpdateAssemblies (string source, string dest)
{
string indexfile = dest + "/index.xml";
index_assemblies.RemoveAll ();
- HashSet<string> goodfiles = new HashSet<string> ();
+ HashSet<string> goodfiles = new HashSet<string> (StringComparer.OrdinalIgnoreCase);
foreach (AssemblyDefinition assm in assemblies) {
AddIndexAssembly (assm, index_assemblies);
private void DoUpdateAssembly (AssemblyDefinition assembly, XmlElement index_types, string source, string dest, HashSet<string> goodfiles)
{
- foreach (DocsTypeInfo docTypeInfo in GetTypes (assembly, null)) {
- TypeDefinition type = docTypeInfo.Type;
+ foreach (TypeDefinition type in docEnum.GetDocumentationTypes (assembly, null)) {
string typename = GetTypeFileName(type);
- if (!IsPublic (type) || typename.IndexOfAny (InvalidFilenameChars) >= 0)
+ if (!IsPublic (type) || typename.IndexOfAny (InvalidFilenameChars) >= 0 || forwardedTypes.Contains (type.FullName))
continue;
- string reltypepath = DoUpdateType (type, source, dest, docTypeInfo.EcmaDocs);
+ string reltypepath = DoUpdateType (type, source, dest);
if (reltypepath == null)
continue;
// Add namespace and type nodes into the index file as needed
- string ns = DocUtils.GetNamespace (type);
- XmlElement nsnode = (XmlElement) index_types.SelectSingleNode("Namespace[@Name='" + ns + "']");
- if (nsnode == null) {
- nsnode = index_types.OwnerDocument.CreateElement("Namespace");
- nsnode.SetAttribute ("Name", ns);
- index_types.AppendChild(nsnode);
- }
- string doc_typename = GetDocTypeName (type);
- XmlElement typenode = (XmlElement)nsnode.SelectSingleNode("Type[@Name='" + typename + "']");
- if (typenode == null) {
- typenode = index_types.OwnerDocument.CreateElement("Type");
- typenode.SetAttribute("Name", typename);
- nsnode.AppendChild(typenode);
- }
- if (typename != doc_typename)
- typenode.SetAttribute("DisplayName", doc_typename);
- else
- typenode.RemoveAttribute("DisplayName");
- typenode.SetAttribute ("Kind", GetTypeKind (type));
+ AddIndexType (type, index_types);
// Ensure the namespace index file exists
string onsdoc = DocUtils.PathCombine (dest, type.Namespace + ".xml");
}
}
- class DocsTypeInfo {
- public TypeDefinition Type;
- public XmlReader EcmaDocs;
-
- public DocsTypeInfo (TypeDefinition type, XmlReader docs)
- {
- this.Type = type;
- this.EcmaDocs = docs;
- }
- }
-
- IEnumerable<Mono.Documentation.MDocUpdater.DocsTypeInfo> GetTypes (AssemblyDefinition assembly, List<string> forTypes)
- {
- HashSet<string> seen = null;
- if (forTypes != null)
- forTypes.Sort ();
- if (ecmadocs != null) {
- seen = new HashSet<string> ();
- int typeDepth = -1;
- while (ecmadocs.Read ()) {
- switch (ecmadocs.Name) {
- case "Type": {
- if (typeDepth == -1)
- typeDepth = ecmadocs.Depth;
- if (ecmadocs.NodeType != XmlNodeType.Element)
- continue;
- if (typeDepth != ecmadocs.Depth) // nested <TypeDefinition/> element?
- continue;
- string typename = ecmadocs.GetAttribute ("FullName");
- string typename2 = GetTypeFileName (typename);
- if (forTypes != null &&
- forTypes.BinarySearch (typename) < 0 &&
- typename != typename2 &&
- forTypes.BinarySearch (typename2) < 0)
- continue;
- TypeDefinition t;
- if ((t = assembly.GetType (typename)) == null &&
- (t = assembly.GetType (typename2)) == null)
- continue;
- seen.Add (typename);
- if (typename != typename2)
- seen.Add (typename2);
- Console.WriteLine (" Import: {0}", t.FullName);
- yield return new DocsTypeInfo (t, ecmadocs);
- break;
- }
- default:
- break;
- }
- }
- }
- foreach (TypeDefinition type in assembly.GetTypes()) {
- if (forTypes != null && forTypes.BinarySearch (type.FullName) < 0)
- continue;
- if (seen != null && seen.Contains (type.FullName))
- continue;
- yield return new DocsTypeInfo (type, null);
- foreach (TypeDefinition nested in type.NestedTypes)
- yield return new DocsTypeInfo (nested, null);
- }
- }
-
private static void SortIndexEntries (XmlElement indexTypes)
{
XmlNodeList namespaces = indexTypes.SelectNodes ("Namespace");
{
TypeDefinition decl = type;
while (decl != null) {
- if (!(decl.IsPublic || decl.IsNestedPublic)) {
+ if (!(decl.IsPublic || decl.IsNestedPublic ||
+ decl.IsNestedFamily || decl.IsNestedFamily || decl.IsNestedFamilyOrAssembly)) {
return false;
}
decl = (TypeDefinition) decl.DeclaringType;
XmlDocument doc = new XmlDocument ();
doc.Load (typefile.FullName);
XmlElement e = doc.SelectSingleNode("/Type") as XmlElement;
- if (UpdateAssemblyVersions(e, GetAssemblyVersions(), false)) {
+ if (!no_assembly_versions && UpdateAssemblyVersions(e, GetAssemblyVersions(), false)) {
using (TextWriter writer = OpenWrite (typefile.FullName, FileMode.Truncate))
WriteXml(doc.DocumentElement, writer);
goodfiles.Add (relTypeFile);
static readonly XmlNodeComparer DefaultExtensionMethodComparer = new ExtensionMethodComparer ();
- public void DoUpdateType2 (string message, XmlDocument basefile, TypeDefinition type, string output, bool insertSince, XmlReader ecmaDocsType)
+ public void DoUpdateType2 (string message, XmlDocument basefile, TypeDefinition type, string output, bool insertSince)
{
Console.WriteLine(message + ": " + type.FullName);
StringToXmlNodeMap seenmembers = new StringToXmlNodeMap ();
// Update type metadata
- UpdateType(basefile.DocumentElement, type, ecmaDocsType);
-
- if (ecmaDocsType != null) {
- while (ecmaDocsType.Name != "Members" && ecmaDocsType.Read ()) {
- // do nothing
- }
- if (ecmaDocsType.IsEmptyElement)
- ecmaDocsType = null;
- }
+ UpdateType(basefile.DocumentElement, type);
// Update existing members. Delete member nodes that no longer should be there,
// and remember what members are already documented so we don't add them again.
if (true) {
MyXmlNodeList todelete = new MyXmlNodeList ();
- foreach (DocsNodeInfo info in GetDocumentationMembers (basefile, type, ecmaDocsType)) {
+ foreach (DocsNodeInfo info in docEnum.GetDocumentationMembers (basefile, type)) {
XmlElement oldmember = info.Node;
- IMemberReference oldmember2 = info.Member;
- string sig = oldmember2 != null ? MakeMemberSignature(oldmember2) : null;
+ MemberReference oldmember2 = info.Member;
+ string sig = oldmember2 != null ? memberFormatters [0].GetDeclaration (oldmember2) : null;
// Interface implementations and overrides are deleted from the docs
// unless the overrides option is given.
// Deleted (or signature changed)
if (oldmember2 == null) {
- if (UpdateAssemblyVersions (oldmember, new string[]{ GetAssemblyVersion (type.Module.Assembly) }, false))
+ if (!no_assembly_versions && UpdateAssemblyVersions (oldmember, new string[]{ GetAssemblyVersion (type.Module.Assembly) }, false))
continue;
DeleteMember ("Member Removed", output, oldmember, todelete);
continue;
if (!DocUtils.IsDelegate (type)) {
XmlNode members = WriteElement (basefile.DocumentElement, "Members");
- foreach (IMemberReference m in type.GetMembers()) {
+ foreach (MemberReference m in type.GetMembers()) {
if (m is TypeDefinition) continue;
- string sig = MakeMemberSignature(m);
+ string sig = memberFormatters [0].GetDeclaration (m);
if (sig == null) continue;
if (seenmembers.ContainsKey(sig)) continue;
return null;
}
- private IEnumerable<DocsNodeInfo> GetDocumentationMembers (XmlDocument basefile, TypeDefinition type, XmlReader ecmaDocsMembers)
- {
- if (ecmaDocsMembers != null) {
- int membersDepth = ecmaDocsMembers.Depth;
- bool go = true;
- while (go && ecmaDocsMembers.Read ()) {
- switch (ecmaDocsMembers.Name) {
- case "Member": {
- if (membersDepth != ecmaDocsMembers.Depth - 1 || ecmaDocsMembers.NodeType != XmlNodeType.Element)
- continue;
- DocumentationMember dm = new DocumentationMember (ecmaDocsMembers);
- string xp = GetXPathForMember (dm);
- XmlElement oldmember = (XmlElement) basefile.SelectSingleNode (xp);
- IMemberReference m;
- if (oldmember == null) {
- m = GetMember (type, dm);
- if (m == null) {
- Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
- type.FullName, dm.MemberSignatures ["C#"]);
- // SelectSingleNode (ecmaDocsMember, "MemberSignature[@Language=\"C#\"]/@Value").Value);
- continue;
- }
- // oldmember lookup may have failed due to type parameter renames.
- // Try again.
- oldmember = (XmlElement) basefile.SelectSingleNode (GetXPathForMember (m));
- if (oldmember == null) {
- XmlElement members = WriteElement(basefile.DocumentElement, "Members");
- oldmember = basefile.CreateElement ("Member");
- oldmember.SetAttribute ("MemberName", dm.MemberName);
- members.AppendChild (oldmember);
- foreach (string key in Sort (dm.MemberSignatures.Keys)) {
- XmlElement ms = basefile.CreateElement ("MemberSignature");
- ms.SetAttribute ("Language", key);
- ms.SetAttribute ("Value", (string) dm.MemberSignatures [key]);
- oldmember.AppendChild (ms);
- }
- oldmember.SetAttribute ("__monodocer-seen__", "true");
- Console.WriteLine ("Member Added: {0}", MakeMemberSignature (m));
- additions++;
- }
- }
- else {
- m = GetMember (type, new DocumentationMember (oldmember));
- if (m == null) {
- Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
- type.FullName, dm.MemberSignatures ["C#"]);
- continue;
- }
- oldmember.SetAttribute ("__monodocer-seen__", "true");
- }
- DocsNodeInfo node = new DocsNodeInfo (oldmember, m);
- if (ecmaDocsMembers.Name != "Docs")
- throw new InvalidOperationException ("Found " + ecmaDocsMembers.Name + "; expected <Docs/>!");
- node.EcmaDocs = ecmaDocsMembers;
- yield return node;
- break;
- }
- case "Members":
- if (membersDepth == ecmaDocsMembers.Depth && ecmaDocsMembers.NodeType == XmlNodeType.EndElement) {
- go = false;
- }
- break;
- }
- }
- }
- foreach (XmlElement oldmember in basefile.SelectNodes("Type/Members/Member")) {
- if (oldmember.GetAttribute ("__monodocer-seen__") == "true") {
- oldmember.RemoveAttribute ("__monodocer-seen__");
- continue;
- }
- IMemberReference m = GetMember (type, new DocumentationMember (oldmember));
- if (m == null) {
- yield return new DocsNodeInfo (oldmember);
- }
- else {
- yield return new DocsNodeInfo (oldmember, m);
- }
- }
- }
-
void DeleteMember (string reason, string output, XmlNode member, MyXmlNodeList todelete)
{
string format = output != null
}
// UPDATE HELPER FUNCTIONS
+
+ // CREATE A STUB DOCUMENTATION FILE
- private static IMemberReference GetMember (TypeDefinition type, DocumentationMember member)
+ public XmlElement StubType (TypeDefinition type, string output)
{
- string membertype = member.MemberType;
-
- string returntype = member.ReturnType;
+ string typesig = typeFormatters [0].GetDeclaration (type);
+ if (typesig == null) return null; // not publicly visible
- string docName = member.MemberName;
- string[] docTypeParams = GetTypeParameters (docName);
+ XmlDocument doc = new XmlDocument();
+ XmlElement root = doc.CreateElement("Type");
+ doc.AppendChild (root);
- // Loop through all members in this type with the same name
- foreach (IMemberReference mi in GetReflectionMembers (type, docName)) {
- if (mi is TypeDefinition) continue;
- if (GetMemberType(mi) != membertype) continue;
+ DoUpdateType2 ("New Type", doc, type, output, true);
+
+ return root;
+ }
- string sig = MakeMemberSignature(mi);
- if (sig == null) continue; // not publicly visible
+ private XmlElement CreateSinceNode (XmlDocument doc)
+ {
+ XmlElement s = doc.CreateElement ("since");
+ s.SetAttribute ("version", since);
+ return s;
+ }
+
+ // STUBBING/UPDATING FUNCTIONS
+
+ public void UpdateType (XmlElement root, TypeDefinition type)
+ {
+ root.SetAttribute("Name", GetDocTypeName (type));
+ root.SetAttribute("FullName", GetDocTypeFullName (type));
- ParameterDefinitionCollection pis = null;
- string[] typeParams = null;
- if (mi is MethodDefinition) {
- MethodDefinition mb = (MethodDefinition) mi;
- pis = mb.Parameters;
- if (docTypeParams != null && mb.IsGenericMethod ()) {
- GenericParameterCollection args = mb.GenericParameters;
- if (args.Count == docTypeParams.Length) {
- typeParams = args.Cast<GenericParameter> ().Select (p => p.Name).ToArray ();
- }
- }
- }
- else if (mi is PropertyDefinition)
- pis = ((PropertyDefinition)mi).Parameters;
+ foreach (MemberFormatter f in typeFormatters) {
+ string element = "TypeSignature[@Language='" + f.Language + "']";
+ WriteElementAttribute (root, element, "Language", f.Language);
+ WriteElementAttribute (root, element, "Value", f.GetDeclaration (type));
+ }
+
+ XmlElement ass = WriteElement(root, "AssemblyInfo");
+ WriteElementText(ass, "AssemblyName", type.Module.Assembly.Name.Name);
+ if (!no_assembly_versions) {
+ UpdateAssemblyVersions (root, type, true);
+ }
+ else {
+ var versions = ass.SelectNodes ("AssemblyVersion").Cast<XmlNode> ().ToList ();
+ foreach (var version in versions)
+ ass.RemoveChild (version);
+ }
+ if (!string.IsNullOrEmpty (type.Module.Assembly.Name.Culture))
+ WriteElementText(ass, "AssemblyCulture", type.Module.Assembly.Name.Culture);
+ else
+ ClearElement(ass, "AssemblyCulture");
+
+ // Why-oh-why do we put assembly attributes in each type file?
+ // Neither monodoc nor monodocs2html use them, so I'm deleting them
+ // since they're outdated in current docs, and a waste of space.
+ //MakeAttributes(ass, type.Assembly, true);
+ XmlNode assattrs = ass.SelectSingleNode("Attributes");
+ if (assattrs != null)
+ ass.RemoveChild(assattrs);
+
+ NormalizeWhitespace(ass);
+
+ if (type.IsGenericType ()) {
+ MakeTypeParameters (root, type.GenericParameters);
+ } else {
+ ClearElement(root, "TypeParameters");
+ }
+
+ if (type.BaseType != null) {
+ XmlElement basenode = WriteElement(root, "Base");
- int mcount = member.Parameters == null ? 0 : member.Parameters.Count;
- int pcount = pis == null ? 0 : pis.Count;
- if (mcount != pcount)
- continue;
+ string basetypename = GetDocTypeFullName (type.BaseType);
+ if (basetypename == "System.MulticastDelegate") basetypename = "System.Delegate";
+ WriteElementText(root, "Base/BaseTypeName", basetypename);
+
+ // Document how this type instantiates the generic parameters of its base type
+ TypeReference origBase = type.BaseType.GetElementType ();
+ if (origBase.IsGenericType ()) {
+ ClearElement(basenode, "BaseTypeArguments");
+ GenericInstanceType baseInst = type.BaseType as GenericInstanceType;
+ IList<TypeReference> baseGenArgs = baseInst == null ? null : baseInst.GenericArguments;
+ IList<GenericParameter> baseGenParams = origBase.GenericParameters;
+ if (baseGenArgs.Count != baseGenParams.Count)
+ throw new InvalidOperationException ("internal error: number of generic arguments doesn't match number of generic parameters.");
+ for (int i = 0; baseGenArgs != null && i < baseGenArgs.Count; i++) {
+ GenericParameter param = baseGenParams [i];
+ TypeReference value = baseGenArgs [i];
- MethodDefinition mDef = mi as MethodDefinition;
- if (mDef != null && !mDef.IsConstructor) {
- // Casting operators can overload based on return type.
- if (returntype != GetReplacedString (
- GetDocTypeFullName (((MethodDefinition)mi).ReturnType.ReturnType),
- typeParams, docTypeParams)) {
- continue;
+ XmlElement bta = WriteElement(basenode, "BaseTypeArguments");
+ XmlElement arg = bta.OwnerDocument.CreateElement("BaseTypeArgument");
+ bta.AppendChild(arg);
+ arg.SetAttribute ("TypeParamName", param.Name);
+ arg.InnerText = GetDocTypeFullName (value);
}
}
-
- if (pcount == 0)
- return mi;
- bool good = true;
- for (int i = 0; i < pis.Count; i++) {
- string paramType = GetReplacedString (
- GetDocParameterType (pis [i].ParameterType),
- typeParams, docTypeParams);
- if (paramType != (string) member.Parameters [i]) {
- good = false;
- break;
- }
- }
- if (!good) continue;
-
- return mi;
- }
-
- return null;
- }
-
- private static IEnumerable<IMemberReference> GetReflectionMembers (TypeDefinition type, string docName)
- {
- // need to worry about 4 forms of //@MemberName values:
- // 1. "Normal" (non-generic) member names: GetEnumerator
- // - Lookup as-is.
- // 2. Explicitly-implemented interface member names: System.Collections.IEnumerable.Current
- // - try as-is, and try type.member (due to "kludge" for property
- // support.
- // 3. "Normal" Generic member names: Sort<T> (CSC)
- // - need to remove generic parameters --> "Sort"
- // 4. Explicitly-implemented interface members for generic interfaces:
- // -- System.Collections.Generic.IEnumerable<T>.Current
- // - Try as-is, and try type.member, *keeping* the generic parameters.
- // --> System.Collections.Generic.IEnumerable<T>.Current, IEnumerable<T>.Current
- // 5. As of 2008-01-02, gmcs will do e.g. 'IFoo`1[A].Method' instead of
- // 'IFoo<A>.Method' for explicitly implemented methods; don't interpret
- // this as (1) or (2).
- if (docName.IndexOf ('<') == -1 && docName.IndexOf ('[') == -1) {
- // Cases 1 & 2
- foreach (IMemberReference mi in type.GetMembers (docName))
- yield return mi;
- if (CountChars (docName, '.') > 0)
- // might be a property; try only type.member instead of
- // namespace.type.member.
- foreach (IMemberReference mi in
- type.GetMembers (DocUtils.GetTypeDotMember (docName)))
- yield return mi;
- yield break;
- }
- // cases 3 & 4
- int numLt = 0;
- int numDot = 0;
- int startLt, startType, startMethod;
- startLt = startType = startMethod = -1;
- for (int i = 0; i < docName.Length; ++i) {
- switch (docName [i]) {
- case '<':
- if (numLt == 0) {
- startLt = i;
- }
- ++numLt;
- break;
- case '>':
- --numLt;
- if (numLt == 0 && (i + 1) < docName.Length)
- // there's another character in docName, so this <...> sequence is
- // probably part of a generic type -- case 4.
- startLt = -1;
- break;
- case '.':
- startType = startMethod;
- startMethod = i;
- ++numDot;
- break;
- }
- }
- string refName = startLt == -1 ? docName : docName.Substring (0, startLt);
- // case 3
- foreach (IMemberReference mi in type.GetMembers (refName))
- yield return mi;
-
- // case 4
- foreach (IMemberReference mi in type.GetMembers (refName.Substring (startType + 1)))
- yield return mi;
-
- // If we _still_ haven't found it, we've hit another generic naming issue:
- // post Mono 1.1.18, gmcs generates [[FQTN]] instead of <TypeName> for
- // explicitly-implemented METHOD names (not properties), e.g.
- // "System.Collections.Generic.IEnumerable`1[[Foo, test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]].GetEnumerator"
- // instead of "System.Collections.Generic.IEnumerable<Foo>.GetEnumerator",
- // which the XML docs will contain.
- //
- // Alas, we can't derive the Mono name from docName, so we need to iterate
- // over all member names, convert them into CSC format, and compare... :-(
- if (numDot == 0)
- yield break;
- foreach (IMemberReference mi in type.GetMembers ()) {
- if (GetMemberName (mi) == docName)
- yield return mi;
- }
- }
-
- static string[] GetTypeParameters (string docName)
- {
- if (docName [docName.Length-1] != '>')
- return null;
- StringList types = new StringList ();
- int endToken = docName.Length-2;
- int i = docName.Length-2;
- do {
- if (docName [i] == ',' || docName [i] == '<') {
- types.Add (docName.Substring (i + 1, endToken - i));
- endToken = i-1;
- }
- if (docName [i] == '<')
- break;
- } while (--i >= 0);
-
- types.Reverse ();
- return types.ToArray ();
- }
-
- static string GetReplacedString (string typeName, string[] from, string[] to)
- {
- if (from == null)
- return typeName;
- for (int i = 0; i < from.Length; ++i)
- typeName = typeName.Replace (from [i], to [i]);
- return typeName;
- }
-
- // CREATE A STUB DOCUMENTATION FILE
-
- public XmlElement StubType (TypeDefinition type, string output, XmlReader ecmaDocsType)
- {
- string typesig = MakeTypeSignature(type);
- if (typesig == null) return null; // not publicly visible
-
- XmlDocument doc = new XmlDocument();
- XmlElement root = doc.CreateElement("Type");
- doc.AppendChild (root);
-
- DoUpdateType2 ("New Type", doc, type, output, true, ecmaDocsType);
-
- return root;
- }
-
- private XmlElement CreateSinceNode (XmlDocument doc)
- {
- XmlElement s = doc.CreateElement ("since");
- s.SetAttribute ("version", since);
- return s;
- }
-
- // STUBBING/UPDATING FUNCTIONS
-
- public void UpdateType (XmlElement root, TypeDefinition type, XmlReader ecmaDocsType)
- {
- root.SetAttribute("Name", GetDocTypeName (type));
- root.SetAttribute("FullName", GetDocTypeFullName (type));
-
- WriteElementAttribute(root, "TypeSignature[@Language='C#']", "Language", "C#");
- WriteElementAttribute(root, "TypeSignature[@Language='C#']", "Value", MakeTypeSignature(type));
-
- XmlElement ass = WriteElement(root, "AssemblyInfo");
- WriteElementText(ass, "AssemblyName", type.Module.Assembly.Name.Name);
- if (!no_assembly_versions) {
- UpdateAssemblyVersions (root, type, true);
- }
- else {
- var versions = ass.SelectNodes ("AssemblyVersion").Cast<XmlNode> ().ToList ();
- foreach (var version in versions)
- ass.RemoveChild (version);
- }
- if (!string.IsNullOrEmpty (type.Module.Assembly.Name.Culture))
- WriteElementText(ass, "AssemblyCulture", type.Module.Assembly.Name.Culture);
- else
- ClearElement(ass, "AssemblyCulture");
-
- // Why-oh-why do we put assembly attributes in each type file?
- // Neither monodoc nor monodocs2html use them, so I'm deleting them
- // since they're outdated in current docs, and a waste of space.
- //MakeAttributes(ass, type.Assembly, true);
- XmlNode assattrs = ass.SelectSingleNode("Attributes");
- if (assattrs != null)
- ass.RemoveChild(assattrs);
-
- NormalizeWhitespace(ass);
-
- if (type.IsGenericType ()) {
- MakeTypeParameters (root, type.GenericParameters);
- } else {
- ClearElement(root, "TypeParameters");
- }
-
- if (type.BaseType != null) {
- XmlElement basenode = WriteElement(root, "Base");
-
- string basetypename = GetDocTypeFullName (type.BaseType);
- if (basetypename == "System.MulticastDelegate") basetypename = "System.Delegate";
- WriteElementText(root, "Base/BaseTypeName", basetypename);
-
- // Document how this type instantiates the generic parameters of its base type
- TypeReference origBase = type.BaseType.GetOriginalType ();
- if (origBase.IsGenericType ()) {
- ClearElement(basenode, "BaseTypeArguments");
- GenericInstanceType baseInst = type.BaseType as GenericInstanceType;
- GenericArgumentCollection baseGenArgs = baseInst == null ? null : baseInst.GenericArguments;
- GenericParameterCollection baseGenParams = origBase.GenericParameters;
- if (baseGenArgs.Count != baseGenParams.Count)
- throw new InvalidOperationException ("internal error: number of generic arguments doesn't match number of generic parameters.");
- for (int i = 0; baseGenArgs != null && i < baseGenArgs.Count; i++) {
- GenericParameter param = baseGenParams [i];
- TypeReference value = baseGenArgs [i];
-
- XmlElement bta = WriteElement(basenode, "BaseTypeArguments");
- XmlElement arg = bta.OwnerDocument.CreateElement("BaseTypeArgument");
- bta.AppendChild(arg);
- arg.SetAttribute ("TypeParamName", param.Name);
- arg.InnerText = GetDocTypeFullName (value);
- }
- }
- } else {
- ClearElement(root, "Base");
- }
+ } else {
+ ClearElement(root, "Base");
+ }
if (!DocUtils.IsDelegate (type) && !type.IsEnum) {
IEnumerable<TypeReference> userInterfaces = DocUtils.GetUserImplementedInterfaces (type);
ClearElement(root, "Interfaces");
}
- MakeAttributes (root, type.CustomAttributes, 0);
+ MakeAttributes (root, GetCustomAttributes (type));
if (DocUtils.IsDelegate (type)) {
MakeTypeParameters (root, type.GenericParameters);
}
DocsNodeInfo typeInfo = new DocsNodeInfo (WriteElement(root, "Docs"), type);
- if (ecmaDocsType != null) {
- if (ecmaDocsType.Name != "Docs") {
- int depth = ecmaDocsType.Depth;
- while (ecmaDocsType.Read ()) {
- if (ecmaDocsType.Name == "Docs" && ecmaDocsType.Depth == depth + 1)
- break;
- }
- }
- if (!ecmaDocsType.IsStartElement ("Docs"))
- throw new InvalidOperationException ("Found " + ecmaDocsType.Name + "; expecting <Docs/>!");
- typeInfo.EcmaDocs = ecmaDocsType;
- }
MakeDocNode (typeInfo);
if (!DocUtils.IsDelegate (type))
WriteElement (root, "Members");
+ OrderTypeNodes (root, root.ChildNodes);
NormalizeWhitespace(root);
}
- static IEnumerable<T> Sort<T> (IEnumerable<T> list)
+ static readonly string[] TypeNodeOrder = {
+ "TypeSignature",
+ "MemberOfLibrary",
+ "AssemblyInfo",
+ "ThreadingSafetyStatement",
+ "ThreadSafetyStatement",
+ "TypeParameters",
+ "Base",
+ "Interfaces",
+ "Attributes",
+ "Parameters",
+ "ReturnValue",
+ "Docs",
+ "Members",
+ "TypeExcluded",
+ };
+
+ static void OrderTypeNodes (XmlNode member, XmlNodeList children)
+ {
+ ReorderNodes (member, children, TypeNodeOrder);
+ }
+
+ internal static IEnumerable<T> Sort<T> (IEnumerable<T> list)
{
List<T> l = new List<T> (list);
l.Sort ();
private void UpdateMember (DocsNodeInfo info)
{
XmlElement me = (XmlElement) info.Node;
- IMemberReference mi = info.Member;
- WriteElementAttribute(me, "MemberSignature[@Language='C#']", "Language", "C#");
- WriteElementAttribute(me, "MemberSignature[@Language='C#']", "Value", MakeMemberSignature(mi));
+ MemberReference mi = info.Member;
+
+ foreach (MemberFormatter f in memberFormatters) {
+ string element = "MemberSignature[@Language='" + f.Language + "']";
+ WriteElementAttribute (me, element, "Language", f.Language);
+ WriteElementAttribute (me, element, "Value", f.GetDeclaration (mi));
+ }
WriteElementText(me, "MemberType", GetMemberType(mi));
ClearElement (me, "AssemblyInfo");
}
- ICustomAttributeProvider p = mi as ICustomAttributeProvider;
- if (p != null)
- MakeAttributes (me, p.CustomAttributes, 0);
-
- PropertyReference pr = mi as PropertyReference;
- if (pr != null) {
- PropertyDefinition pd = pr.Resolve ();
- if (pd.GetMethod != null)
- MakeAttributes (me, pd.GetMethod.CustomAttributes, AttributeFlags.KeepExistingAttributes, "get: ");
- if (pd.SetMethod != null)
- MakeAttributes (me, pd.SetMethod.CustomAttributes, AttributeFlags.KeepExistingAttributes, "set: ");
- }
- EventReference er = mi as EventReference;
- if (er != null) {
- EventDefinition ed = er.Resolve ();
- if (ed.AddMethod != null)
- MakeAttributes (me, ed.AddMethod.CustomAttributes, AttributeFlags.KeepExistingAttributes, "add: ");
- if (ed.RemoveMethod != null)
- MakeAttributes (me, ed.RemoveMethod.CustomAttributes, AttributeFlags.KeepExistingAttributes, "remove: ");
- }
+ MakeAttributes (me, GetCustomAttributes (mi));
MakeReturnValue(me, mi);
if (mi is MethodReference) {
info.Node = WriteElement (me, "Docs");
MakeDocNode (info);
+ OrderMemberNodes (me, me.ChildNodes);
UpdateExtensionMethods (me, info);
}
- static readonly string[] ValidExtensionMembers = {
- "Docs",
+ static readonly string[] MemberNodeOrder = {
"MemberSignature",
"MemberType",
- "Parameters",
+ "AssemblyInfo",
+ "Attributes",
"ReturnValue",
"TypeParameters",
+ "Parameters",
+ "MemberValue",
+ "Docs",
+ "Excluded",
+ "ExcludedLibrary",
+ "Link",
};
- static readonly string[] ValidExtensionDocMembers = {
- "param",
- "summary",
- "typeparam",
- };
-
- private void UpdateExtensionMethods (XmlElement e, DocsNodeInfo info)
+ static void OrderMemberNodes (XmlNode member, XmlNodeList children)
{
- MethodDefinition me = info.Member as MethodDefinition;
- if (me == null)
- return;
- if (info.Parameters.Count < 1)
- return;
- if (!DocUtils.IsExtensionMethod (me))
- return;
+ ReorderNodes (member, children, MemberNodeOrder);
+ }
- XmlNode em = e.OwnerDocument.CreateElement ("ExtensionMethod");
- XmlNode member = e.CloneNode (true);
- em.AppendChild (member);
- RemoveExcept (member, ValidExtensionMembers);
- RemoveExcept (member.SelectSingleNode ("Docs"), ValidExtensionDocMembers);
- WriteElementText (member, "MemberType", "ExtensionMethod");
- XmlElement link = member.OwnerDocument.CreateElement ("Link");
- link.SetAttribute ("Type", slashdocFormatter.GetName (me.DeclaringType));
- link.SetAttribute ("Member", slashdocFormatter.GetDeclaration (me));
- member.AppendChild (link);
- AddTargets (em, info);
+ static void ReorderNodes (XmlNode node, XmlNodeList children, string[] ordering)
+ {
+ MyXmlNodeList newChildren = new MyXmlNodeList (children.Count);
+ for (int i = 0; i < ordering.Length; ++i) {
+ for (int j = 0; j < children.Count; ++j) {
+ XmlNode c = children [j];
+ if (c.Name == ordering [i]) {
+ newChildren.Add (c);
+ }
+ }
+ }
+ if (newChildren.Count >= 0)
+ node.PrependChild ((XmlNode) newChildren [0]);
+ for (int i = 1; i < newChildren.Count; ++i) {
+ XmlNode prev = (XmlNode) newChildren [i-1];
+ XmlNode cur = (XmlNode) newChildren [i];
+ node.RemoveChild (cur);
+ node.InsertAfter (cur, prev);
+ }
+ }
+
+ IEnumerable<string> GetCustomAttributes (MemberReference mi)
+ {
+ IEnumerable<string> attrs = Enumerable.Empty<string>();
+
+ ICustomAttributeProvider p = mi as ICustomAttributeProvider;
+ if (p != null)
+ attrs = attrs.Concat (GetCustomAttributes (p.CustomAttributes, ""));
+
+ PropertyDefinition pd = mi as PropertyDefinition;
+ if (pd != null) {
+ if (pd.GetMethod != null)
+ attrs = attrs.Concat (GetCustomAttributes (pd.GetMethod.CustomAttributes, "get: "));
+ if (pd.SetMethod != null)
+ attrs = attrs.Concat (GetCustomAttributes (pd.SetMethod.CustomAttributes, "set: "));
+ }
+
+ EventDefinition ed = mi as EventDefinition;
+ if (ed != null) {
+ if (ed.AddMethod != null)
+ attrs = attrs.Concat (GetCustomAttributes (ed.AddMethod.CustomAttributes, "add: "));
+ if (ed.RemoveMethod != null)
+ attrs = attrs.Concat (GetCustomAttributes (ed.RemoveMethod.CustomAttributes, "remove: "));
+ }
+
+ return attrs;
+ }
+
+ IEnumerable<string> GetCustomAttributes (IList<CustomAttribute> attributes, string prefix)
+ {
+ foreach (CustomAttribute attribute in attributes.OrderBy (ca => ca.AttributeType.FullName)) {
+
+ TypeDefinition attrType = attribute.AttributeType as TypeDefinition;
+ if (attrType != null && !IsPublic (attrType))
+ continue;
+ if (slashdocFormatter.GetName (attribute.AttributeType) == null)
+ continue;
+
+ if (Array.IndexOf (IgnorableAttributes, attribute.AttributeType.FullName) >= 0)
+ continue;
+
+ StringList fields = new StringList ();
+
+ for (int i = 0; i < attribute.ConstructorArguments.Count; ++i) {
+ CustomAttributeArgument argument = attribute.ConstructorArguments [i];
+ fields.Add (MakeAttributesValueString (
+ argument.Value,
+ argument.Type));
+ }
+ var namedArgs =
+ (from namedArg in attribute.Fields
+ select new { Type=namedArg.Argument.Type, Name=namedArg.Name, Value=namedArg.Argument.Value })
+ .Concat (
+ (from namedArg in attribute.Properties
+ select new { Type=namedArg.Argument.Type, Name=namedArg.Name, Value=namedArg.Argument.Value }))
+ .OrderBy (v => v.Name);
+ foreach (var d in namedArgs)
+ fields.Add (string.Format ("{0}={1}", d.Name,
+ MakeAttributesValueString (d.Value, d.Type)));
+
+ string a2 = String.Join(", ", fields.ToArray ());
+ if (a2 != "") a2 = "(" + a2 + ")";
+
+ string name = attribute.GetDeclaringType();
+ if (name.EndsWith("Attribute")) name = name.Substring(0, name.Length-"Attribute".Length);
+ yield return prefix + name + a2;
+ }
+ }
+
+ static readonly string[] ValidExtensionMembers = {
+ "Docs",
+ "MemberSignature",
+ "MemberType",
+ "Parameters",
+ "ReturnValue",
+ "TypeParameters",
+ };
+
+ static readonly string[] ValidExtensionDocMembers = {
+ "param",
+ "summary",
+ "typeparam",
+ };
+
+ private void UpdateExtensionMethods (XmlElement e, DocsNodeInfo info)
+ {
+ MethodDefinition me = info.Member as MethodDefinition;
+ if (me == null)
+ return;
+ if (info.Parameters.Count < 1)
+ return;
+ if (!DocUtils.IsExtensionMethod (me))
+ return;
+
+ XmlNode em = e.OwnerDocument.CreateElement ("ExtensionMethod");
+ XmlNode member = e.CloneNode (true);
+ em.AppendChild (member);
+ RemoveExcept (member, ValidExtensionMembers);
+ RemoveExcept (member.SelectSingleNode ("Docs"), ValidExtensionDocMembers);
+ WriteElementText (member, "MemberType", "ExtensionMethod");
+ XmlElement link = member.OwnerDocument.CreateElement ("Link");
+ link.SetAttribute ("Type", slashdocFormatter.GetName (me.DeclaringType));
+ link.SetAttribute ("Member", slashdocFormatter.GetDeclaration (me));
+ member.AppendChild (link);
+ AddTargets (em, info);
extensionMethods.Add (em);
}
}
else {
GenericParameter gp = (GenericParameter) info.Parameters [0].ParameterType;
- ConstraintCollection constraints = gp.Constraints;
+ IList<TypeReference> constraints = gp.Constraints;
if (constraints.Count == 0)
AppendElementAttributeText (targets, "Target", "Type", "System.Object");
else
// XML HELPER FUNCTIONS
- private static XmlElement WriteElement(XmlNode parent, string element) {
+ internal static XmlElement WriteElement(XmlNode parent, string element) {
XmlElement ret = (XmlElement)parent.SelectSingleNode(element);
if (ret == null) {
string[] path = element.Split('/');
return n;
}
- private static XmlNode CopyNode (XmlNode source, XmlNode dest)
+ internal static XmlNode CopyNode (XmlNode source, XmlNode dest)
{
XmlNode copy = dest.OwnerDocument.ImportNode (source, true);
dest.AppendChild (copy);
if (node.GetAttribute(attribute) == value) return;
node.SetAttribute(attribute, value);
}
- private static void ClearElement(XmlElement parent, string name) {
+ internal static void ClearElement(XmlElement parent, string name) {
XmlElement node = (XmlElement)parent.SelectSingleNode(name);
if (node != null)
parent.RemoveChild(node);
private void MakeDocNode (DocsNodeInfo info)
{
List<GenericParameter> genericParams = info.GenericParameters;
- ParameterDefinitionCollection parameters = info.Parameters;
+ IList<ParameterDefinition> parameters = info.Parameters;
TypeReference returntype = info.ReturnType;
bool returnisreturn = info.ReturnIsReturn;
XmlElement e = info.Node;
UpdateExceptions (e, info.Member);
}
- if (info.EcmaDocs != null) {
- XmlReader r = info.EcmaDocs;
- int depth = r.Depth;
- r.ReadStartElement ("Docs");
- while (r.Read ()) {
- if (r.Name == "Docs") {
- if (r.Depth == depth && r.NodeType == XmlNodeType.EndElement)
- break;
- else
- throw new InvalidOperationException ("Skipped past current <Docs/> element!");
- }
- if (!r.IsStartElement ())
- continue;
- switch (r.Name) {
- case "param":
- case "typeparam": {
- string name = r.GetAttribute ("name");
- if (name == null)
- break;
- XmlNode doc = e.SelectSingleNode (
- r.Name + "[@name='" + name + "']");
- string value = r.ReadInnerXml ();
- if (doc != null)
- doc.InnerXml = value.Replace ("\r", "");
- break;
- }
- case "altmember":
- case "exception":
- case "permission":
- case "seealso": {
- string name = r.Name;
- string cref = r.GetAttribute ("cref");
- if (cref == null)
- break;
- XmlNode doc = e.SelectSingleNode (
- r.Name + "[@cref='" + cref + "']");
- string value = r.ReadInnerXml ().Replace ("\r", "");
- if (doc != null)
- doc.InnerXml = value;
- else {
- XmlElement n = e.OwnerDocument.CreateElement (name);
- n.SetAttribute ("cref", cref);
- n.InnerXml = value;
- e.AppendChild (n);
- }
- break;
- }
- default: {
- string name = r.Name;
- string xpath = r.Name;
- StringList attributes = new StringList (r.AttributeCount);
- if (r.MoveToFirstAttribute ()) {
- do {
- attributes.Add ("@" + r.Name + "=\"" + r.Value + "\"");
- } while (r.MoveToNextAttribute ());
- r.MoveToContent ();
- }
- if (attributes.Count > 0) {
- xpath += "[" + string.Join (" and ", attributes.ToArray ()) + "]";
- }
- XmlNode doc = e.SelectSingleNode (xpath);
- string value = r.ReadInnerXml ().Replace ("\r", "");
- if (doc != null) {
- doc.InnerXml = value;
- }
- else {
- XmlElement n = e.OwnerDocument.CreateElement (name);
- n.InnerXml = value;
- foreach (string a in attributes) {
- int eq = a.IndexOf ('=');
- n.SetAttribute (a.Substring (1, eq-1), a.Substring (eq+2, a.Length-eq-3));
- }
- e.AppendChild (n);
- }
- break;
- }
- }
- }
- }
- if (info.SlashDocs != null) {
- XmlNode elem = info.SlashDocs;
- if (elem != null) {
- if (elem.SelectSingleNode("summary") != null)
- ClearElement(e, "summary");
- if (elem.SelectSingleNode("remarks") != null)
- ClearElement(e, "remarks");
- if (elem.SelectSingleNode("value") != null)
- ClearElement(e, "value");
- if (retnodename != null && elem.SelectSingleNode(retnodename) != null)
- ClearElement(e, retnodename);
-
- foreach (XmlNode child in elem.ChildNodes) {
- switch (child.Name) {
- case "param":
- case "typeparam": {
- XmlAttribute name = child.Attributes ["name"];
- if (name == null)
- break;
- XmlElement p2 = (XmlElement) e.SelectSingleNode (child.Name + "[@name='" + name.Value + "']");
- if (p2 != null)
- p2.InnerXml = child.InnerXml;
- break;
- }
- case "altmember":
- case "exception":
- case "permission": {
- XmlAttribute cref = child.Attributes ["cref"] ?? child.Attributes ["name"];
- if (cref == null)
- break;
- XmlElement a = (XmlElement) e.SelectSingleNode (child.Name + "[@cref='" + cref.Value + "']");
- if (a == null) {
- a = e.OwnerDocument.CreateElement (child.Name);
- a.SetAttribute ("cref", child.Attributes ["cref"].Value);
- e.AppendChild (a);
- }
- a.InnerXml = child.InnerXml;
- break;
- }
- case "seealso": {
- XmlAttribute cref = child.Attributes ["cref"];
- if (cref == null)
- break;
- XmlElement a = (XmlElement) e.SelectSingleNode ("altmember[@cref='" + cref.Value + "']");
- if (a == null) {
- a = e.OwnerDocument.CreateElement ("altmember");
- a.SetAttribute ("cref", child.Attributes ["cref"].Value);
- e.AppendChild (a);
- }
- break;
- }
- default:
- CopyNode (child, e);
- break;
- }
- }
- }
- }
+ foreach (DocumentationImporter importer in importers)
+ importer.ImportDocumentation (info);
OrderDocsNodes (e, e.ChildNodes);
NormalizeWhitespace(e);
private static void OrderDocsNodes (XmlNode docs, XmlNodeList children)
{
- MyXmlNodeList newChildren = new MyXmlNodeList (children.Count);
- for (int i = 0; i < DocsNodeOrder.Length; ++i) {
- for (int j = 0; j < children.Count; ++j) {
- XmlNode c = children [j];
- if (c.Name == DocsNodeOrder [i]) {
- newChildren.Add (c);
- }
- }
- }
- if (newChildren.Count >= 0)
- docs.PrependChild ((XmlNode) newChildren [0]);
- for (int i = 1; i < newChildren.Count; ++i) {
- XmlNode prev = (XmlNode) newChildren [i-1];
- XmlNode cur = (XmlNode) newChildren [i];
- docs.RemoveChild (cur);
- docs.InsertAfter (cur, prev);
- }
+ ReorderNodes (docs, children, DocsNodeOrder);
}
}
}
- private void UpdateExceptions (XmlNode docs, IMemberReference member)
+ private void UpdateExceptions (XmlNode docs, MemberReference member)
{
foreach (var source in new ExceptionLookup (exceptions.Value)[member]) {
string cref = slashdocFormatter.GetDeclaration (source.Exception);
n.ParentNode.RemoveChild(n);
}
- private static bool UpdateAssemblyVersions (XmlElement root, IMemberReference member, bool add)
+ private static bool UpdateAssemblyVersions (XmlElement root, MemberReference member, bool add)
{
TypeDefinition type = member as TypeDefinition;
if (type == null)
"System.Runtime.CompilerServices.UnsafeValueTypeAttribute",
// extension methods
"System.Runtime.CompilerServices.ExtensionAttribute",
+ // Used to differentiate 'object' from C#4 'dynamic'
+ "System.Runtime.CompilerServices.DynamicAttribute",
};
- [Flags]
- enum AttributeFlags {
- None,
- KeepExistingAttributes = 0x1,
- }
-
- private void MakeAttributes (XmlElement root, CustomAttributeCollection attributes, AttributeFlags flags)
- {
- MakeAttributes (root, attributes, flags, null);
- }
-
- private void MakeAttributes (XmlElement root, CustomAttributeCollection attributes, AttributeFlags flags, string prefix)
+ private void MakeAttributes (XmlElement root, IEnumerable<string> attributes)
{
- bool keepExisting = (flags & AttributeFlags.KeepExistingAttributes) != 0;
- if (attributes.Count == 0) {
- if (!keepExisting)
- ClearElement(root, "Attributes");
+ if (!attributes.Any ()) {
+ ClearElement (root, "Attributes");
return;
}
- bool b = false;
XmlElement e = (XmlElement)root.SelectSingleNode("Attributes");
- if (e != null && !keepExisting)
+ if (e != null)
e.RemoveAll();
else if (e == null)
e = root.OwnerDocument.CreateElement("Attributes");
- foreach (CustomAttribute attribute in attributes.Cast<CustomAttribute> ()
- .OrderBy (ca => ca.Constructor.DeclaringType.FullName)) {
- if (!attribute.Resolve ()) {
- // skip?
- Warning ("warning: could not resolve type {0}.",
- attribute.Constructor.DeclaringType.FullName);
- }
- TypeDefinition attrType = attribute.Constructor.DeclaringType as TypeDefinition;
- if (attrType != null && !IsPublic (attrType))
- continue;
- if (slashdocFormatter.GetName (attribute.Constructor.DeclaringType) == null)
- continue;
-
- if (Array.IndexOf (IgnorableAttributes, attribute.Constructor.DeclaringType.FullName) >= 0)
- continue;
-
- b = true;
-
- StringList fields = new StringList ();
-
- ParameterDefinitionCollection parameters = attribute.Constructor.Parameters;
- for (int i = 0; i < attribute.ConstructorParameters.Count; ++i) {
- fields.Add (MakeAttributesValueString (
- attribute.ConstructorParameters [i],
- parameters [i].ParameterType));
- }
- var namedArgs =
- (from de in attribute.Fields.Cast<DictionaryEntry> ()
- select new { Type=attribute.GetFieldType (de.Key.ToString ()), Name=de.Key, Value=de.Value })
- .Concat (
- (from de in attribute.Properties.Cast<DictionaryEntry> ()
- select new { Type=attribute.GetPropertyType (de.Key.ToString ()), Name=de.Key, Value=de.Value }))
- .OrderBy (v => v.Name);
- foreach (var d in namedArgs)
- fields.Add (string.Format ("{0}={1}", d.Name,
- MakeAttributesValueString (d.Value, d.Type)));
-
- string a2 = String.Join(", ", fields.ToArray ());
- if (a2 != "") a2 = "(" + a2 + ")";
-
+ foreach (string attribute in attributes) {
XmlElement ae = root.OwnerDocument.CreateElement("Attribute");
e.AppendChild(ae);
- string name = attribute.Constructor.DeclaringType.FullName;
- if (name.EndsWith("Attribute")) name = name.Substring(0, name.Length-"Attribute".Length);
- WriteElementText(ae, "AttributeName", prefix + name + a2);
+ WriteElementText(ae, "AttributeName", attribute);
}
- if (b && e.ParentNode == null)
+ if (e.ParentNode == null)
root.AppendChild(e);
- else if (!b)
- ClearElement(root, "Attributes");
-
+
NormalizeWhitespace(e);
}
- private static string MakeAttributesValueString (object v, TypeReference valueType)
+ public static string MakeAttributesValueString (object v, TypeReference valueType)
{
if (v == null)
return "null";
return "typeof(" + v.ToString () + ")";
if (valueType.FullName == "System.String")
return "\"" + v.ToString () + "\"";
+ if (valueType.FullName == "System.Char")
+ return "'" + v.ToString () + "'";
if (v is Boolean)
return (bool)v ? "true" : "false";
TypeDefinition valueDef = valueType.Resolve ();
long c = ToInt64 (v);
if (values.ContainsKey (c))
return typename + "." + values [c];
- if (valueDef.CustomAttributes.Cast<CustomAttribute> ()
- .Any (ca => ca.Constructor.DeclaringType.FullName == "System.FlagsAttribute")) {
+ if (valueDef.CustomAttributes.Any (ca => ca.AttributeType.FullName == "System.FlagsAttribute")) {
return string.Join (" | ",
(from i in values.Keys
where (c & i) != 0
select typename + "." + values [i])
- .ToArray ());
+ .DefaultIfEmpty (v.ToString ()).ToArray ());
}
return "(" + GetDocTypeFullName (valueType) + ") " + v.ToString ();
}
{
var values = new Dictionary<long, string> ();
foreach (var f in
- (from f in type.Fields.Cast<FieldDefinition> ()
+ (from f in type.Fields
where !(f.IsRuntimeSpecialName || f.IsSpecialName)
select f)) {
values [ToInt64 (f.Constant)] = f.Name;
return Convert.ToInt64 (value);
}
- private void MakeParameters (XmlElement root, ParameterDefinitionCollection parameters)
+ private void MakeParameters (XmlElement root, IList<ParameterDefinition> parameters)
{
XmlElement e = WriteElement(root, "Parameters");
e.RemoveAll();
e.AppendChild(pe);
pe.SetAttribute("Name", p.Name);
pe.SetAttribute("Type", GetDocParameterType (p.ParameterType));
- if (p.ParameterType is ReferenceType) {
+ if (p.ParameterType is ByReferenceType) {
if (p.IsOut) pe.SetAttribute("RefType", "out");
else pe.SetAttribute("RefType", "ref");
}
- MakeAttributes (pe, p.CustomAttributes, 0);
+ MakeAttributes (pe, GetCustomAttributes (p.CustomAttributes, ""));
}
}
- private void MakeTypeParameters (XmlElement root, GenericParameterCollection typeParams)
+ private void MakeTypeParameters (XmlElement root, IList<GenericParameter> typeParams)
{
if (typeParams == null || typeParams.Count == 0) {
XmlElement f = (XmlElement) root.SelectSingleNode ("TypeParameters");
XmlElement pe = root.OwnerDocument.CreateElement("TypeParameter");
e.AppendChild(pe);
pe.SetAttribute("Name", t.Name);
- MakeAttributes (pe, t.CustomAttributes, 0);
+ MakeAttributes (pe, GetCustomAttributes (t.CustomAttributes, ""));
XmlElement ce = (XmlElement) e.SelectSingleNode ("Constraints");
- ConstraintCollection constraints = t.Constraints;
+ IList<TypeReference> constraints = t.Constraints;
GenericParameterAttributes attrs = t.Attributes;
if (attrs == GenericParameterAttributes.NonVariant && constraints.Count == 0) {
if (ce != null)
}
}
- private void MakeParameters (XmlElement root, IMemberReference mi)
+ private void MakeParameters (XmlElement root, MemberReference mi)
{
if (mi is MethodDefinition && ((MethodDefinition) mi).IsConstructor)
MakeParameters (root, ((MethodDefinition)mi).Parameters);
else if (mi is MethodDefinition) {
MethodDefinition mb = (MethodDefinition) mi;
- ParameterDefinitionCollection parameters = mb.Parameters;
+ IList<ParameterDefinition> parameters = mb.Parameters;
MakeParameters(root, parameters);
if (parameters.Count > 0 && DocUtils.IsExtensionMethod (mb)) {
XmlElement p = (XmlElement) root.SelectSingleNode ("Parameters/Parameter[position()=1]");
}
}
else if (mi is PropertyDefinition) {
- ParameterDefinitionCollection parameters = ((PropertyDefinition)mi).Parameters;
+ IList<ParameterDefinition> parameters = ((PropertyDefinition)mi).Parameters;
if (parameters.Count > 0)
MakeParameters(root, parameters);
else
else throw new ArgumentException();
}
- private static string GetDocParameterType (TypeReference type)
+ internal static string GetDocParameterType (TypeReference type)
{
return GetDocTypeFullName (type).Replace ("@", "&");
}
- private void MakeReturnValue (XmlElement root, TypeReference type, CustomAttributeCollection attributes)
+ private void MakeReturnValue (XmlElement root, TypeReference type, IList<CustomAttribute> attributes)
{
XmlElement e = WriteElement(root, "ReturnValue");
e.RemoveAll();
WriteElementText(e, "ReturnType", GetDocTypeFullName (type));
if (attributes != null)
- MakeAttributes(e, attributes, 0);
+ MakeAttributes(e, GetCustomAttributes (attributes, ""));
}
- private void MakeReturnValue (XmlElement root, IMemberReference mi)
+ private void MakeReturnValue (XmlElement root, MemberReference mi)
{
if (mi is MethodDefinition && ((MethodDefinition) mi).IsConstructor)
return;
else if (mi is MethodDefinition)
- MakeReturnValue (root, ((MethodDefinition)mi).ReturnType.ReturnType, ((MethodDefinition)mi).ReturnType.CustomAttributes);
+ MakeReturnValue (root, ((MethodDefinition)mi).ReturnType, ((MethodDefinition)mi).MethodReturnType.CustomAttributes);
else if (mi is PropertyDefinition)
MakeReturnValue (root, ((PropertyDefinition)mi).PropertyType, null);
else if (mi is FieldDefinition)
private XmlElement MakeMember(XmlDocument doc, DocsNodeInfo info)
{
- IMemberReference mi = info.Member;
+ MemberReference mi = info.Member;
if (mi is TypeDefinition) return null;
- string sigs = MakeMemberSignature(mi);
+ string sigs = memberFormatters [0].GetDeclaration (mi);
if (sigs == null) return null; // not publicly visible
// no documentation for property/event accessors. Is there a better way of doing this?
return me;
}
- private static string GetMemberName (IMemberReference mi)
+ internal static string GetMemberName (MemberReference mi)
{
MethodDefinition mb = mi as MethodDefinition;
if (mb == null) {
sb.Append (ifaceMethod.Name);
}
if (mb.IsGenericMethod ()) {
- GenericParameterCollection typeParams = mb.GenericParameters;
+ IList<GenericParameter> typeParams = mb.GenericParameters;
if (typeParams.Count > 0) {
sb.Append ("<");
sb.Append (typeParams [0].Name);
}
return sb.ToString ();
}
-
- private static int CountChars (string s, char c)
- {
- int count = 0;
- for (int i = 0; i < s.Length; ++i) {
- if (s [i] == c)
- ++count;
- }
- return count;
- }
/// SIGNATURE GENERATION FUNCTIONS
-
- static string MakeTypeSignature (TypeReference type)
- {
- return csharpFormatter.GetDeclaration (type);
- }
-
- static string MakeMemberSignature (IMemberReference mi)
+ internal static bool IsPrivate (MemberReference mi)
{
- return csharpFullFormatter.GetDeclaration (mi);
+ return memberFormatters [0].GetDeclaration (mi) == null;
}
- static string GetMemberType (IMemberReference mi)
+ internal static string GetMemberType (MemberReference mi)
{
if (mi is MethodDefinition && ((MethodDefinition) mi).IsConstructor)
return "Constructor";
return docTypeFormatter.GetName (type);
}
- private static string GetDocTypeFullName (TypeReference type)
+ internal static string GetDocTypeFullName (TypeReference type)
{
return DocTypeFullMemberFormatter.Default.GetName (type);
}
- class DocsNodeInfo {
- public DocsNodeInfo (XmlElement node)
- {
- this.Node = node;
- }
-
- public DocsNodeInfo (XmlElement node, TypeDefinition type)
- : this (node)
- {
- SetType (type);
- }
-
- public DocsNodeInfo (XmlElement node, IMemberReference member)
- : this (node)
- {
- SetMemberInfo (member);
- }
-
- void SetType (TypeDefinition type)
- {
- if (type == null)
- throw new ArgumentNullException ("type");
- GenericParameters = new List<GenericParameter> (type.GenericParameters.Cast<GenericParameter> ());
- List<TypeReference> declTypes = DocUtils.GetDeclaringTypes (type);
- int maxGenArgs = DocUtils.GetGenericArgumentCount (type);
- for (int i = 0; i < declTypes.Count - 1; ++i) {
- int remove = System.Math.Min (maxGenArgs,
- DocUtils.GetGenericArgumentCount (declTypes [i]));
- maxGenArgs -= remove;
- while (remove-- > 0)
- GenericParameters.RemoveAt (0);
- }
- if (DocUtils.IsDelegate (type)) {
- Parameters = type.GetMethod("Invoke").Parameters;
- ReturnType = type.GetMethod("Invoke").ReturnType.ReturnType;
- }
- SetSlashDocs (type);
- }
-
- void SetMemberInfo (IMemberReference member)
- {
- if (member == null)
- throw new ArgumentNullException ("member");
- ReturnIsReturn = true;
- AddRemarks = true;
- Member = member;
-
- if (member is MethodReference ) {
- MethodReference mr = (MethodReference) member;
- Parameters = mr.Parameters;
- if (mr.IsGenericMethod ()) {
- GenericParameters = new List<GenericParameter> (mr.GenericParameters.Cast<GenericParameter> ());
- }
- }
- else if (member is PropertyDefinition) {
- Parameters = ((PropertyDefinition) member).Parameters;
- }
-
- if (member is MethodDefinition) {
- ReturnType = ((MethodDefinition) member).ReturnType.ReturnType;
- } else if (member is PropertyDefinition) {
- ReturnType = ((PropertyDefinition) member).PropertyType;
- ReturnIsReturn = false;
- }
-
- // no remarks section for enum members
- if (member.DeclaringType != null && ((TypeDefinition) member.DeclaringType).IsEnum)
- AddRemarks = false;
- SetSlashDocs (member);
- }
-
- private void SetSlashDocs (IMemberReference member)
- {
- if (slashdocs == null)
- return;
-
- string slashdocsig = slashdocFormatter.GetDeclaration (member);
- if (slashdocsig != null)
- SlashDocs = slashdocs.SelectSingleNode ("doc/members/member[@name='" + slashdocsig + "']");
- }
-
- public TypeReference ReturnType;
- public List<GenericParameter> GenericParameters;
- public ParameterDefinitionCollection Parameters;
- public bool ReturnIsReturn;
- public XmlElement Node;
- public bool AddRemarks = true;
- public XmlNode SlashDocs;
- public XmlReader EcmaDocs;
- public IMemberReference Member;
- }
-
- static string GetXPathForMember (DocumentationMember member)
+ internal static string GetXPathForMember (DocumentationMember member)
{
StringBuilder xpath = new StringBuilder ();
xpath.Append ("//Members/Member[@MemberName=\"")
return xpath.ToString ();
}
- public static string GetXPathForMember (IMemberReference member)
+ public static string GetXPathForMember (MemberReference member)
{
StringBuilder xpath = new StringBuilder ();
xpath.Append ("//Type[@FullName=\"")
.Append (GetMemberName (member))
.Append ("\"]");
- ParameterDefinitionCollection parameters = null;
+ IList<ParameterDefinition> parameters = null;
if (member is MethodDefinition)
parameters = ((MethodDefinition) member).Parameters;
else if (member is PropertyDefinition) {
}
static class CecilExtensions {
- public static IEnumerable<IMemberReference> GetMembers (this TypeDefinition type)
+ public static string GetDeclaringType(this CustomAttribute attribute)
+ {
+ return attribute.Constructor.DeclaringType.FullName;
+ }
+
+ public static IEnumerable<MemberReference> GetMembers (this TypeDefinition type)
{
- foreach (var c in type.Constructors)
- yield return (IMemberReference) c;
+ foreach (var c in type.Methods.Where (m => m.IsConstructor))
+ yield return (MemberReference) c;
foreach (var e in type.Events)
- yield return (IMemberReference) e;
+ yield return (MemberReference) e;
foreach (var f in type.Fields)
- yield return (IMemberReference) f;
- foreach (var m in type.Methods)
- yield return (IMemberReference) m;
+ yield return (MemberReference) f;
+ foreach (var m in type.Methods.Where (m => !m.IsConstructor))
+ yield return (MemberReference) m;
foreach (var t in type.NestedTypes)
- yield return (IMemberReference) t;
+ yield return (MemberReference) t;
foreach (var p in type.Properties)
- yield return (IMemberReference) p;
+ yield return (MemberReference) p;
}
- public static IEnumerable<IMemberReference> GetMembers (this TypeDefinition type, string member)
+ public static IEnumerable<MemberReference> GetMembers (this TypeDefinition type, string member)
{
return GetMembers (type).Where (m => m.Name == member);
}
- public static IMemberReference GetMember (this TypeDefinition type, string member)
+ public static MemberReference GetMember (this TypeDefinition type, string member)
{
return GetMembers (type, member).EnsureZeroOrOne ();
}
public static MethodDefinition GetMethod (this TypeDefinition type, string method)
{
- return type.Methods.Cast<MethodDefinition> ()
+ return type.Methods
.Where (m => m.Name == method)
.EnsureZeroOrOne ();
}
- public static IEnumerable<IMemberReference> GetDefaultMembers (this TypeReference type)
+ public static IEnumerable<MemberReference> GetDefaultMembers (this TypeReference type)
{
TypeDefinition def = type as TypeDefinition;
if (def == null)
- return new IMemberReference [0];
- CustomAttribute defMemberAttr = type.CustomAttributes.Cast<CustomAttribute> ()
- .Where (c => c.Constructor.DeclaringType.FullName == "System.Reflection.DefaultMemberAttribute")
- .FirstOrDefault ();
+ return new MemberReference [0];
+ CustomAttribute defMemberAttr = def.CustomAttributes
+ .FirstOrDefault (c => c.AttributeType.FullName == "System.Reflection.DefaultMemberAttribute");
if (defMemberAttr == null)
- return new IMemberReference [0];
- string name = (string) defMemberAttr.ConstructorParameters [0];
- return def.Properties.Cast<PropertyDefinition> ()
+ return new MemberReference [0];
+ string name = (string) defMemberAttr.ConstructorArguments [0].Value;
+ return def.Properties
.Where (p => p.Name == name)
- .Select (p => (IMemberReference) p);
+ .Select (p => (MemberReference) p);
+ }
+
+ public static IEnumerable<TypeDefinition> GetTypes (this AssemblyDefinition assembly)
+ {
+ return assembly.Modules.SelectMany (md => md.GetAllTypes ());
+ }
+
+ public static TypeDefinition GetType (this AssemblyDefinition assembly, string type)
+ {
+ return GetTypes (assembly)
+ .Where (td => td.FullName == type)
+ .EnsureZeroOrOne ();
+ }
+
+ public static bool IsGenericType (this TypeReference type)
+ {
+ return type.GenericParameters.Count > 0;
+ }
+
+ public static bool IsGenericMethod (this MethodReference method)
+ {
+ return method.GenericParameters.Count > 0;
+ }
+
+ public static MemberReference Resolve (this MemberReference member)
+ {
+ FieldReference fr = member as FieldReference;
+ if (fr != null)
+ return fr.Resolve ();
+ MethodReference mr = member as MethodReference;
+ if (mr != null)
+ return mr.Resolve ();
+ TypeReference tr = member as TypeReference;
+ if (tr != null)
+ return tr.Resolve ();
+ PropertyReference pr = member as PropertyReference;
+ if (pr != null)
+ return pr;
+ EventReference er = member as EventReference;
+ if (er != null)
+ return er;
+ throw new NotSupportedException ("Cannot find definition for " + member.ToString ());
+ }
+
+ public static TypeReference GetUnderlyingType (this TypeDefinition type)
+ {
+ if (!type.IsEnum)
+ return type;
+ return type.Fields.First (f => f.Name == "value__").FieldType;
+ }
+
+ public static IEnumerable<TypeDefinition> GetAllTypes (this ModuleDefinition self)
+ {
+ return self.Types.SelectMany (t => t.GetAllTypes ());
+ }
+
+ static IEnumerable<TypeDefinition> GetAllTypes (this TypeDefinition self)
+ {
+ yield return self;
+
+ if (!self.HasNestedTypes)
+ yield break;
+
+ foreach (var type in self.NestedTypes.SelectMany (t => t.GetAllTypes ()))
+ yield return type;
+ }
+}
+
+static class DocUtils {
+ public static bool IsExplicitlyImplemented (MethodDefinition method)
+ {
+ return method.IsPrivate && method.IsFinal && method.IsVirtual;
+ }
+
+ public static string GetTypeDotMember (string name)
+ {
+ int startType, startMethod;
+ startType = startMethod = -1;
+ for (int i = 0; i < name.Length; ++i) {
+ if (name [i] == '.') {
+ startType = startMethod;
+ startMethod = i;
+ }
+ }
+ return name.Substring (startType+1);
+ }
+
+ public static string GetMember (string name)
+ {
+ int i = name.LastIndexOf ('.');
+ if (i == -1)
+ return name;
+ return name.Substring (i+1);
+ }
+
+ public static void GetInfoForExplicitlyImplementedMethod (
+ MethodDefinition method, out TypeReference iface, out MethodReference ifaceMethod)
+ {
+ iface = null;
+ ifaceMethod = null;
+ if (method.Overrides.Count != 1)
+ throw new InvalidOperationException ("Could not determine interface type for explicitly-implemented interface member " + method.Name);
+ iface = method.Overrides [0].DeclaringType;
+ ifaceMethod = method.Overrides [0];
+ }
+
+ public static string GetPropertyName (PropertyDefinition pi)
+ {
+ // Issue: (g)mcs-generated assemblies that explicitly implement
+ // properties don't specify the full namespace, just the
+ // TypeName.Property; .NET uses Full.Namespace.TypeName.Property.
+ MethodDefinition method = pi.GetMethod;
+ if (method == null)
+ method = pi.SetMethod;
+ if (!IsExplicitlyImplemented (method))
+ return pi.Name;
+
+ // Need to determine appropriate namespace for this member.
+ TypeReference iface;
+ MethodReference ifaceMethod;
+ GetInfoForExplicitlyImplementedMethod (method, out iface, out ifaceMethod);
+ return string.Join (".", new string[]{
+ DocTypeFullMemberFormatter.Default.GetName (iface),
+ GetMember (pi.Name)});
+ }
+
+ public static string GetNamespace (TypeReference type)
+ {
+ if (type.GetElementType ().IsNested)
+ type = type.GetElementType ();
+ while (type != null && type.IsNested)
+ type = type.DeclaringType;
+ if (type == null)
+ return string.Empty;
+ return type.Namespace;
+ }
+
+ public static string PathCombine (string dir, string path)
+ {
+ if (dir == null)
+ dir = "";
+ if (path == null)
+ path = "";
+ return Path.Combine (dir, path);
+ }
+
+ public static bool IsExtensionMethod (MethodDefinition method)
+ {
+ return
+ method.CustomAttributes
+ .Any (m => m.AttributeType.FullName == "System.Runtime.CompilerServices.ExtensionAttribute")
+ && method.DeclaringType.CustomAttributes
+ .Any (m => m.AttributeType.FullName == "System.Runtime.CompilerServices.ExtensionAttribute");
+ }
+
+ public static bool IsDelegate (TypeDefinition type)
+ {
+ TypeReference baseRef = type.BaseType;
+ if (baseRef == null)
+ return false;
+ return !type.IsAbstract && baseRef.FullName == "System.Delegate" || // FIXME
+ baseRef.FullName == "System.MulticastDelegate";
+ }
+
+ public static List<TypeReference> GetDeclaringTypes (TypeReference type)
+ {
+ List<TypeReference> decls = new List<TypeReference> ();
+ decls.Add (type);
+ while (type.DeclaringType != null) {
+ decls.Add (type.DeclaringType);
+ type = type.DeclaringType;
+ }
+ decls.Reverse ();
+ return decls;
+ }
+
+ public static int GetGenericArgumentCount (TypeReference type)
+ {
+ GenericInstanceType inst = type as GenericInstanceType;
+ return inst != null
+ ? inst.GenericArguments.Count
+ : type.GenericParameters.Count;
+ }
+
+ public static IEnumerable<TypeReference> GetUserImplementedInterfaces (TypeDefinition type)
+ {
+ HashSet<string> inheritedInterfaces = GetInheritedInterfaces (type);
+ List<TypeReference> userInterfaces = new List<TypeReference> ();
+ foreach (TypeReference iface in type.Interfaces) {
+ TypeReference lookup = iface.Resolve () ?? iface;
+ if (!inheritedInterfaces.Contains (GetQualifiedTypeName (lookup)))
+ userInterfaces.Add (iface);
+ }
+ return userInterfaces;
+ }
+
+ private static string GetQualifiedTypeName (TypeReference type)
+ {
+ return "[" + type.Scope.Name + "]" + type.FullName;
+ }
+
+ private static HashSet<string> GetInheritedInterfaces (TypeDefinition type)
+ {
+ HashSet<string> inheritedInterfaces = new HashSet<string> ();
+ Action<TypeDefinition> a = null;
+ a = t => {
+ if (t == null) return;
+ foreach (TypeReference r in t.Interfaces) {
+ inheritedInterfaces.Add (GetQualifiedTypeName (r));
+ a (r.Resolve ());
+ }
+ };
+ TypeReference baseRef = type.BaseType;
+ while (baseRef != null) {
+ TypeDefinition baseDef = baseRef.Resolve ();
+ if (baseDef != null) {
+ a (baseDef);
+ baseRef = baseDef.BaseType;
+ }
+ else
+ baseRef = null;
+ }
+ foreach (TypeReference r in type.Interfaces)
+ a (r.Resolve ());
+ return inheritedInterfaces;
+ }
+}
+
+class DocsNodeInfo {
+ public DocsNodeInfo (XmlElement node)
+ {
+ this.Node = node;
+ }
+
+ public DocsNodeInfo (XmlElement node, TypeDefinition type)
+ : this (node)
+ {
+ SetType (type);
+ }
+
+ public DocsNodeInfo (XmlElement node, MemberReference member)
+ : this (node)
+ {
+ SetMemberInfo (member);
+ }
+
+ void SetType (TypeDefinition type)
+ {
+ if (type == null)
+ throw new ArgumentNullException ("type");
+ Type = type;
+ GenericParameters = new List<GenericParameter> (type.GenericParameters);
+ List<TypeReference> declTypes = DocUtils.GetDeclaringTypes (type);
+ int maxGenArgs = DocUtils.GetGenericArgumentCount (type);
+ for (int i = 0; i < declTypes.Count - 1; ++i) {
+ int remove = System.Math.Min (maxGenArgs,
+ DocUtils.GetGenericArgumentCount (declTypes [i]));
+ maxGenArgs -= remove;
+ while (remove-- > 0)
+ GenericParameters.RemoveAt (0);
+ }
+ if (DocUtils.IsDelegate (type)) {
+ Parameters = type.GetMethod("Invoke").Parameters;
+ ReturnType = type.GetMethod("Invoke").ReturnType;
+ ReturnIsReturn = true;
+ }
+ }
+
+ void SetMemberInfo (MemberReference member)
+ {
+ if (member == null)
+ throw new ArgumentNullException ("member");
+ ReturnIsReturn = true;
+ AddRemarks = true;
+ Member = member;
+
+ if (member is MethodReference ) {
+ MethodReference mr = (MethodReference) member;
+ Parameters = mr.Parameters;
+ if (mr.IsGenericMethod ()) {
+ GenericParameters = new List<GenericParameter> (mr.GenericParameters);
+ }
+ }
+ else if (member is PropertyDefinition) {
+ Parameters = ((PropertyDefinition) member).Parameters;
+ }
+
+ if (member is MethodDefinition) {
+ ReturnType = ((MethodDefinition) member).ReturnType;
+ } else if (member is PropertyDefinition) {
+ ReturnType = ((PropertyDefinition) member).PropertyType;
+ ReturnIsReturn = false;
+ }
+
+ // no remarks section for enum members
+ if (member.DeclaringType != null && ((TypeDefinition) member.DeclaringType).IsEnum)
+ AddRemarks = false;
+ }
+
+ public TypeReference ReturnType;
+ public List<GenericParameter> GenericParameters;
+ public IList<ParameterDefinition> Parameters;
+ public bool ReturnIsReturn;
+ public XmlElement Node;
+ public bool AddRemarks = true;
+ public MemberReference Member;
+ public TypeDefinition Type;
+}
+
+class DocumentationEnumerator {
+
+ public virtual IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes)
+ {
+ return GetDocumentationTypes (assembly, forTypes, null);
+ }
+
+ protected IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes, HashSet<string> seen)
+ {
+ foreach (TypeDefinition type in assembly.GetTypes()) {
+ if (forTypes != null && forTypes.BinarySearch (type.FullName) < 0)
+ continue;
+ if (seen != null && seen.Contains (type.FullName))
+ continue;
+ yield return type;
+ foreach (TypeDefinition nested in type.NestedTypes)
+ yield return nested;
+ }
+ }
+
+ public virtual IEnumerable<DocsNodeInfo> GetDocumentationMembers (XmlDocument basefile, TypeDefinition type)
+ {
+ foreach (XmlElement oldmember in basefile.SelectNodes("Type/Members/Member")) {
+ if (oldmember.GetAttribute ("__monodocer-seen__") == "true") {
+ oldmember.RemoveAttribute ("__monodocer-seen__");
+ continue;
+ }
+ MemberReference m = GetMember (type, new DocumentationMember (oldmember));
+ if (m == null) {
+ yield return new DocsNodeInfo (oldmember);
+ }
+ else {
+ yield return new DocsNodeInfo (oldmember, m);
+ }
+ }
+ }
+
+ protected static MemberReference GetMember (TypeDefinition type, DocumentationMember member)
+ {
+ string membertype = member.MemberType;
+
+ string returntype = member.ReturnType;
+
+ string docName = member.MemberName;
+ string[] docTypeParams = GetTypeParameters (docName);
+
+ // Loop through all members in this type with the same name
+ foreach (MemberReference mi in GetReflectionMembers (type, docName)) {
+ if (mi is TypeDefinition) continue;
+ if (MDocUpdater.GetMemberType(mi) != membertype) continue;
+
+ if (MDocUpdater.IsPrivate (mi))
+ continue;
+
+ IList<ParameterDefinition> pis = null;
+ string[] typeParams = null;
+ if (mi is MethodDefinition) {
+ MethodDefinition mb = (MethodDefinition) mi;
+ pis = mb.Parameters;
+ if (docTypeParams != null && mb.IsGenericMethod ()) {
+ IList<GenericParameter> args = mb.GenericParameters;
+ if (args.Count == docTypeParams.Length) {
+ typeParams = args.Select (p => p.Name).ToArray ();
+ }
+ }
+ }
+ else if (mi is PropertyDefinition)
+ pis = ((PropertyDefinition)mi).Parameters;
+
+ int mcount = member.Parameters == null ? 0 : member.Parameters.Count;
+ int pcount = pis == null ? 0 : pis.Count;
+ if (mcount != pcount)
+ continue;
+
+ MethodDefinition mDef = mi as MethodDefinition;
+ if (mDef != null && !mDef.IsConstructor) {
+ // Casting operators can overload based on return type.
+ if (returntype != GetReplacedString (
+ MDocUpdater.GetDocTypeFullName (((MethodDefinition)mi).ReturnType),
+ typeParams, docTypeParams)) {
+ continue;
+ }
+ }
+
+ if (pcount == 0)
+ return mi;
+ bool good = true;
+ for (int i = 0; i < pis.Count; i++) {
+ string paramType = GetReplacedString (
+ MDocUpdater.GetDocParameterType (pis [i].ParameterType),
+ typeParams, docTypeParams);
+ if (paramType != (string) member.Parameters [i]) {
+ good = false;
+ break;
+ }
+ }
+ if (!good) continue;
+
+ return mi;
+ }
+
+ return null;
+ }
+
+ static string[] GetTypeParameters (string docName)
+ {
+ if (docName [docName.Length-1] != '>')
+ return null;
+ StringList types = new StringList ();
+ int endToken = docName.Length-2;
+ int i = docName.Length-2;
+ do {
+ if (docName [i] == ',' || docName [i] == '<') {
+ types.Add (docName.Substring (i + 1, endToken - i));
+ endToken = i-1;
+ }
+ if (docName [i] == '<')
+ break;
+ } while (--i >= 0);
+
+ types.Reverse ();
+ return types.ToArray ();
+ }
+
+ protected static IEnumerable<MemberReference> GetReflectionMembers (TypeDefinition type, string docName)
+ {
+ // need to worry about 4 forms of //@MemberName values:
+ // 1. "Normal" (non-generic) member names: GetEnumerator
+ // - Lookup as-is.
+ // 2. Explicitly-implemented interface member names: System.Collections.IEnumerable.Current
+ // - try as-is, and try type.member (due to "kludge" for property
+ // support.
+ // 3. "Normal" Generic member names: Sort<T> (CSC)
+ // - need to remove generic parameters --> "Sort"
+ // 4. Explicitly-implemented interface members for generic interfaces:
+ // -- System.Collections.Generic.IEnumerable<T>.Current
+ // - Try as-is, and try type.member, *keeping* the generic parameters.
+ // --> System.Collections.Generic.IEnumerable<T>.Current, IEnumerable<T>.Current
+ // 5. As of 2008-01-02, gmcs will do e.g. 'IFoo`1[A].Method' instead of
+ // 'IFoo<A>.Method' for explicitly implemented methods; don't interpret
+ // this as (1) or (2).
+ if (docName.IndexOf ('<') == -1 && docName.IndexOf ('[') == -1) {
+ // Cases 1 & 2
+ foreach (MemberReference mi in type.GetMembers (docName))
+ yield return mi;
+ if (CountChars (docName, '.') > 0)
+ // might be a property; try only type.member instead of
+ // namespace.type.member.
+ foreach (MemberReference mi in
+ type.GetMembers (DocUtils.GetTypeDotMember (docName)))
+ yield return mi;
+ yield break;
+ }
+ // cases 3 & 4
+ int numLt = 0;
+ int numDot = 0;
+ int startLt, startType, startMethod;
+ startLt = startType = startMethod = -1;
+ for (int i = 0; i < docName.Length; ++i) {
+ switch (docName [i]) {
+ case '<':
+ if (numLt == 0) {
+ startLt = i;
+ }
+ ++numLt;
+ break;
+ case '>':
+ --numLt;
+ if (numLt == 0 && (i + 1) < docName.Length)
+ // there's another character in docName, so this <...> sequence is
+ // probably part of a generic type -- case 4.
+ startLt = -1;
+ break;
+ case '.':
+ startType = startMethod;
+ startMethod = i;
+ ++numDot;
+ break;
+ }
+ }
+ string refName = startLt == -1 ? docName : docName.Substring (0, startLt);
+ // case 3
+ foreach (MemberReference mi in type.GetMembers (refName))
+ yield return mi;
+
+ // case 4
+ foreach (MemberReference mi in type.GetMembers (refName.Substring (startType + 1)))
+ yield return mi;
+
+ // If we _still_ haven't found it, we've hit another generic naming issue:
+ // post Mono 1.1.18, gmcs generates [[FQTN]] instead of <TypeName> for
+ // explicitly-implemented METHOD names (not properties), e.g.
+ // "System.Collections.Generic.IEnumerable`1[[Foo, test, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null]].GetEnumerator"
+ // instead of "System.Collections.Generic.IEnumerable<Foo>.GetEnumerator",
+ // which the XML docs will contain.
+ //
+ // Alas, we can't derive the Mono name from docName, so we need to iterate
+ // over all member names, convert them into CSC format, and compare... :-(
+ if (numDot == 0)
+ yield break;
+ foreach (MemberReference mi in type.GetMembers ()) {
+ if (MDocUpdater.GetMemberName (mi) == docName)
+ yield return mi;
+ }
}
- public static IEnumerable<TypeDefinition> GetTypes (this AssemblyDefinition assembly)
+ static string GetReplacedString (string typeName, string[] from, string[] to)
{
- return assembly.Modules.Cast<ModuleDefinition> ()
- .SelectMany (md => md.Types.Cast<TypeDefinition> ());
+ if (from == null)
+ return typeName;
+ for (int i = 0; i < from.Length; ++i)
+ typeName = typeName.Replace (from [i], to [i]);
+ return typeName;
}
- public static TypeDefinition GetType (this AssemblyDefinition assembly, string type)
+ private static int CountChars (string s, char c)
{
- return GetTypes (assembly)
- .Where (td => td.FullName == type)
- .EnsureZeroOrOne ();
+ int count = 0;
+ for (int i = 0; i < s.Length; ++i) {
+ if (s [i] == c)
+ ++count;
+ }
+ return count;
}
+}
- public static bool IsGenericType (this TypeReference type)
- {
- return type.GenericParameters.Count > 0;
- }
+class EcmaDocumentationEnumerator : DocumentationEnumerator {
- public static bool IsGenericMethod (this MethodReference method)
- {
- return method.GenericParameters.Count > 0;
- }
+ XmlReader ecmadocs;
+ MDocUpdater app;
- public static IMemberReference Resolve (this IMemberReference member)
+ public EcmaDocumentationEnumerator (MDocUpdater app, XmlReader ecmaDocs)
{
- EventReference er = member as EventReference;
- if (er != null)
- return er.Resolve ();
- FieldReference fr = member as FieldReference;
- if (fr != null)
- return fr.Resolve ();
- MethodReference mr = member as MethodReference;
- if (mr != null)
- return mr.Resolve ();
- PropertyReference pr = member as PropertyReference;
- if (pr != null)
- return pr.Resolve ();
- TypeReference tr = member as TypeReference;
- if (tr != null)
- return tr.Resolve ();
- throw new NotSupportedException ("Cannot find definition for " + member.ToString ());
+ this.app = app;
+ this.ecmadocs = ecmaDocs;
}
-}
-static class DocUtils {
- public static bool IsExplicitlyImplemented (MethodDefinition method)
+ public override IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes)
{
- return method.IsPrivate && method.IsFinal && method.IsVirtual;
+ HashSet<string> seen = new HashSet<string> ();
+ return GetDocumentationTypes (assembly, forTypes, seen)
+ .Concat (base.GetDocumentationTypes (assembly, forTypes, seen));
}
- public static string GetTypeDotMember (string name)
+ new IEnumerable<TypeDefinition> GetDocumentationTypes (AssemblyDefinition assembly, List<string> forTypes, HashSet<string> seen)
{
- int startType, startMethod;
- startType = startMethod = -1;
- for (int i = 0; i < name.Length; ++i) {
- if (name [i] == '.') {
- startType = startMethod;
- startMethod = i;
+ int typeDepth = -1;
+ while (ecmadocs.Read ()) {
+ switch (ecmadocs.Name) {
+ case "Type": {
+ if (typeDepth == -1)
+ typeDepth = ecmadocs.Depth;
+ if (ecmadocs.NodeType != XmlNodeType.Element)
+ continue;
+ if (typeDepth != ecmadocs.Depth) // nested <TypeDefinition/> element?
+ continue;
+ string typename = ecmadocs.GetAttribute ("FullName");
+ string typename2 = MDocUpdater.GetTypeFileName (typename);
+ if (forTypes != null &&
+ forTypes.BinarySearch (typename) < 0 &&
+ typename != typename2 &&
+ forTypes.BinarySearch (typename2) < 0)
+ continue;
+ TypeDefinition t;
+ if ((t = assembly.GetType (typename)) == null &&
+ (t = assembly.GetType (typename2)) == null)
+ continue;
+ seen.Add (typename);
+ if (typename != typename2)
+ seen.Add (typename2);
+ Console.WriteLine (" Import: {0}", t.FullName);
+ if (ecmadocs.Name != "Docs") {
+ int depth = ecmadocs.Depth;
+ while (ecmadocs.Read ()) {
+ if (ecmadocs.Name == "Docs" && ecmadocs.Depth == depth + 1)
+ break;
+ }
+ }
+ if (!ecmadocs.IsStartElement ("Docs"))
+ throw new InvalidOperationException ("Found " + ecmadocs.Name + "; expecting <Docs/>!");
+ yield return t;
+ break;
+ }
+ default:
+ break;
}
}
- return name.Substring (startType+1);
}
- public static string GetMember (string name)
+ public override IEnumerable<DocsNodeInfo> GetDocumentationMembers (XmlDocument basefile, TypeDefinition type)
{
- int i = name.LastIndexOf ('.');
- if (i == -1)
- return name;
- return name.Substring (i+1);
+ return GetMembers (basefile, type)
+ .Concat (base.GetDocumentationMembers (basefile, type));
}
- public static void GetInfoForExplicitlyImplementedMethod (
- MethodDefinition method, out TypeReference iface, out MethodReference ifaceMethod)
+ private IEnumerable<DocsNodeInfo> GetMembers (XmlDocument basefile, TypeDefinition type)
{
- iface = null;
- ifaceMethod = null;
- if (method.Overrides.Count != 1)
- throw new InvalidOperationException ("Could not determine interface type for explicitly-implemented interface member " + method.Name);
- iface = method.Overrides [0].DeclaringType;
- ifaceMethod = method.Overrides [0];
+ while (ecmadocs.Name != "Members" && ecmadocs.Read ()) {
+ // do nothing
+ }
+ if (ecmadocs.IsEmptyElement)
+ yield break;
+
+ int membersDepth = ecmadocs.Depth;
+ bool go = true;
+ while (go && ecmadocs.Read ()) {
+ switch (ecmadocs.Name) {
+ case "Member": {
+ if (membersDepth != ecmadocs.Depth - 1 || ecmadocs.NodeType != XmlNodeType.Element)
+ continue;
+ DocumentationMember dm = new DocumentationMember (ecmadocs);
+ string xp = MDocUpdater.GetXPathForMember (dm);
+ XmlElement oldmember = (XmlElement) basefile.SelectSingleNode (xp);
+ MemberReference m;
+ if (oldmember == null) {
+ m = GetMember (type, dm);
+ if (m == null) {
+ app.Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
+ type.FullName, dm.MemberSignatures ["C#"]);
+ // SelectSingleNode (ecmaDocsMember, "MemberSignature[@Language=\"C#\"]/@Value").Value);
+ continue;
+ }
+ // oldmember lookup may have failed due to type parameter renames.
+ // Try again.
+ oldmember = (XmlElement) basefile.SelectSingleNode (MDocUpdater.GetXPathForMember (m));
+ if (oldmember == null) {
+ XmlElement members = MDocUpdater.WriteElement (basefile.DocumentElement, "Members");
+ oldmember = basefile.CreateElement ("Member");
+ oldmember.SetAttribute ("MemberName", dm.MemberName);
+ members.AppendChild (oldmember);
+ foreach (string key in MDocUpdater.Sort (dm.MemberSignatures.Keys)) {
+ XmlElement ms = basefile.CreateElement ("MemberSignature");
+ ms.SetAttribute ("Language", key);
+ ms.SetAttribute ("Value", (string) dm.MemberSignatures [key]);
+ oldmember.AppendChild (ms);
+ }
+ oldmember.SetAttribute ("__monodocer-seen__", "true");
+ Console.WriteLine ("Member Added: {0}", oldmember.SelectSingleNode("MemberSignature[@Language='C#']/@Value").InnerText);
+ app.additions++;
+ }
+ }
+ else {
+ m = GetMember (type, new DocumentationMember (oldmember));
+ if (m == null) {
+ app.Warning ("Could not import ECMA docs for `{0}'s `{1}': Member not found.",
+ type.FullName, dm.MemberSignatures ["C#"]);
+ continue;
+ }
+ oldmember.SetAttribute ("__monodocer-seen__", "true");
+ }
+ DocsNodeInfo node = new DocsNodeInfo (oldmember, m);
+ if (ecmadocs.Name != "Docs")
+ throw new InvalidOperationException ("Found " + ecmadocs.Name + "; expected <Docs/>!");
+ yield return node;
+ break;
+ }
+ case "Members":
+ if (membersDepth == ecmadocs.Depth && ecmadocs.NodeType == XmlNodeType.EndElement) {
+ go = false;
+ }
+ break;
+ }
+ }
}
+}
- public static string GetPropertyName (PropertyDefinition pi)
- {
- // Issue: (g)mcs-generated assemblies that explicitly implement
- // properties don't specify the full namespace, just the
- // TypeName.Property; .NET uses Full.Namespace.TypeName.Property.
- MethodDefinition method = pi.GetMethod;
- if (method == null)
- method = pi.SetMethod;
- if (!IsExplicitlyImplemented (method))
- return pi.Name;
+abstract class DocumentationImporter {
- // Need to determine appropriate namespace for this member.
- TypeReference iface;
- MethodReference ifaceMethod;
- GetInfoForExplicitlyImplementedMethod (method, out iface, out ifaceMethod);
- return string.Join (".", new string[]{
- DocTypeFullMemberFormatter.Default.GetName (iface),
- GetMember (pi.Name)});
- }
+ public abstract void ImportDocumentation (DocsNodeInfo info);
+}
- public static string GetNamespace (TypeReference type)
- {
- if (type.GetOriginalType ().IsNested)
- type = type.GetOriginalType ();
- while (type != null && type.IsNested)
- type = type.DeclaringType;
- if (type == null)
- return string.Empty;
- return type.Namespace;
- }
+class MsxdocDocumentationImporter : DocumentationImporter {
- public static string PathCombine (string dir, string path)
- {
- if (dir == null)
- dir = "";
- if (path == null)
- path = "";
- return Path.Combine (dir, path);
- }
+ XmlDocument slashdocs;
- public static bool IsExtensionMethod (MethodDefinition method)
+ public MsxdocDocumentationImporter (string file)
{
- return
- method.CustomAttributes.Cast<CustomAttribute> ()
- .Where (m => m.Constructor.DeclaringType.FullName == "System.Runtime.CompilerServices.ExtensionAttribute")
- .Any () &&
- method.DeclaringType.CustomAttributes.Cast<CustomAttribute> ()
- .Where (m => m.Constructor.DeclaringType.FullName == "System.Runtime.CompilerServices.ExtensionAttribute")
- .Any ();
- }
+ var xml = File.ReadAllText (file);
- public static bool IsDelegate (TypeDefinition type)
- {
- TypeReference baseRef = type.BaseType;
- if (baseRef == null)
- return false;
- return !type.IsAbstract && baseRef.FullName == "System.Delegate" || // FIXME
- baseRef.FullName == "System.MulticastDelegate";
+ // Ensure Unix line endings
+ xml = xml.Replace ("\r", "");
+
+ slashdocs = new XmlDocument();
+ slashdocs.LoadXml (xml);
}
- public static List<TypeReference> GetDeclaringTypes (TypeReference type)
+ public override void ImportDocumentation (DocsNodeInfo info)
{
- List<TypeReference> decls = new List<TypeReference> ();
- decls.Add (type);
- while (type.DeclaringType != null) {
- decls.Add (type.DeclaringType);
- type = type.DeclaringType;
+ XmlNode elem = GetDocs (info.Member ?? info.Type);
+
+ if (elem == null)
+ return;
+
+ XmlElement e = info.Node;
+
+ if (elem.SelectSingleNode("summary") != null)
+ MDocUpdater.ClearElement(e, "summary");
+ if (elem.SelectSingleNode("remarks") != null)
+ MDocUpdater.ClearElement(e, "remarks");
+ if (elem.SelectSingleNode ("value") != null || elem.SelectSingleNode ("returns") != null) {
+ MDocUpdater.ClearElement(e, "value");
+ MDocUpdater.ClearElement(e, "returns");
}
- decls.Reverse ();
- return decls;
- }
- public static int GetGenericArgumentCount (TypeReference type)
- {
- GenericInstanceType inst = type as GenericInstanceType;
- return inst != null
- ? inst.GenericArguments.Count
- : type.GenericParameters.Count;
+ foreach (XmlNode child in elem.ChildNodes) {
+ switch (child.Name) {
+ case "param":
+ case "typeparam": {
+ XmlAttribute name = child.Attributes ["name"];
+ if (name == null)
+ break;
+ XmlElement p2 = (XmlElement) e.SelectSingleNode (child.Name + "[@name='" + name.Value + "']");
+ if (p2 != null)
+ p2.InnerXml = child.InnerXml;
+ break;
+ }
+ // Occasionally XML documentation will use <returns/> on
+ // properties, so let's try to normalize things.
+ case "value":
+ case "returns": {
+ XmlElement v = e.OwnerDocument.CreateElement (info.ReturnIsReturn ? "returns" : "value");
+ v.InnerXml = child.InnerXml;
+ e.AppendChild (v);
+ break;
+ }
+ case "altmember":
+ case "exception":
+ case "permission": {
+ XmlAttribute cref = child.Attributes ["cref"] ?? child.Attributes ["name"];
+ if (cref == null)
+ break;
+ XmlElement a = (XmlElement) e.SelectSingleNode (child.Name + "[@cref='" + cref.Value + "']");
+ if (a == null) {
+ a = e.OwnerDocument.CreateElement (child.Name);
+ a.SetAttribute ("cref", child.Attributes ["cref"].Value);
+ e.AppendChild (a);
+ }
+ a.InnerXml = child.InnerXml;
+ break;
+ }
+ case "seealso": {
+ XmlAttribute cref = child.Attributes ["cref"];
+ if (cref == null)
+ break;
+ XmlElement a = (XmlElement) e.SelectSingleNode ("altmember[@cref='" + cref.Value + "']");
+ if (a == null) {
+ a = e.OwnerDocument.CreateElement ("altmember");
+ a.SetAttribute ("cref", child.Attributes ["cref"].Value);
+ e.AppendChild (a);
+ }
+ break;
+ }
+ default: {
+ bool add = true;
+ if (child.NodeType == XmlNodeType.Element &&
+ e.SelectNodes (child.Name).Cast<XmlElement>().Any (n => n.OuterXml == child.OuterXml))
+ add = false;
+ if (add)
+ MDocUpdater.CopyNode (child, e);
+ break;
+ }
+ }
+ }
}
- public static IEnumerable<TypeReference> GetUserImplementedInterfaces (TypeDefinition type)
+ private XmlNode GetDocs (MemberReference member)
{
- HashSet<string> inheritedInterfaces = GetInheritedInterfaces (type);
- List<TypeReference> userInterfaces = new List<TypeReference> ();
- foreach (TypeReference iface in type.Interfaces) {
- TypeReference lookup = iface.Resolve () ?? iface;
- if (!inheritedInterfaces.Contains (GetQualifiedTypeName (lookup)))
- userInterfaces.Add (iface);
- }
- return userInterfaces;
+ string slashdocsig = MDocUpdater.slashdocFormatter.GetDeclaration (member);
+ if (slashdocsig != null)
+ return slashdocs.SelectSingleNode ("doc/members/member[@name='" + slashdocsig + "']");
+ return null;
}
+}
- private static string GetQualifiedTypeName (TypeReference type)
+class EcmaDocumentationImporter : DocumentationImporter {
+
+ XmlReader ecmadocs;
+
+ public EcmaDocumentationImporter (XmlReader ecmaDocs)
{
- return "[" + type.Scope.Name + "]" + type.FullName;
+ this.ecmadocs = ecmaDocs;
}
- private static HashSet<string> GetInheritedInterfaces (TypeDefinition type)
+ public override void ImportDocumentation (DocsNodeInfo info)
{
- HashSet<string> inheritedInterfaces = new HashSet<string> ();
- Action<TypeDefinition> a = null;
- a = t => {
- if (t == null) return;
- foreach (TypeReference r in t.Interfaces) {
- inheritedInterfaces.Add (GetQualifiedTypeName (r));
- a (r.Resolve ());
+ if (!ecmadocs.IsStartElement ("Docs")) {
+ return;
+ }
+
+ XmlElement e = info.Node;
+
+ int depth = ecmadocs.Depth;
+ ecmadocs.ReadStartElement ("Docs");
+ while (ecmadocs.Read ()) {
+ if (ecmadocs.Name == "Docs") {
+ if (ecmadocs.Depth == depth && ecmadocs.NodeType == XmlNodeType.EndElement)
+ break;
+ else
+ throw new InvalidOperationException ("Skipped past current <Docs/> element!");
}
- };
- TypeReference baseRef = type.BaseType;
- while (baseRef != null) {
- TypeDefinition baseDef = baseRef.Resolve ();
- if (baseDef != null) {
- a (baseDef);
- baseRef = baseDef.BaseType;
+ if (!ecmadocs.IsStartElement ())
+ continue;
+ switch (ecmadocs.Name) {
+ case "param":
+ case "typeparam": {
+ string name = ecmadocs.GetAttribute ("name");
+ if (name == null)
+ break;
+ XmlNode doc = e.SelectSingleNode (
+ ecmadocs.Name + "[@name='" + name + "']");
+ string value = ecmadocs.ReadInnerXml ();
+ if (doc != null)
+ doc.InnerXml = value.Replace ("\r", "");
+ break;
+ }
+ case "altmember":
+ case "exception":
+ case "permission":
+ case "seealso": {
+ string name = ecmadocs.Name;
+ string cref = ecmadocs.GetAttribute ("cref");
+ if (cref == null)
+ break;
+ XmlNode doc = e.SelectSingleNode (
+ ecmadocs.Name + "[@cref='" + cref + "']");
+ string value = ecmadocs.ReadInnerXml ().Replace ("\r", "");
+ if (doc != null)
+ doc.InnerXml = value;
+ else {
+ XmlElement n = e.OwnerDocument.CreateElement (name);
+ n.SetAttribute ("cref", cref);
+ n.InnerXml = value;
+ e.AppendChild (n);
+ }
+ break;
+ }
+ default: {
+ string name = ecmadocs.Name;
+ string xpath = ecmadocs.Name;
+ StringList attributes = new StringList (ecmadocs.AttributeCount);
+ if (ecmadocs.MoveToFirstAttribute ()) {
+ do {
+ attributes.Add ("@" + ecmadocs.Name + "=\"" + ecmadocs.Value + "\"");
+ } while (ecmadocs.MoveToNextAttribute ());
+ ecmadocs.MoveToContent ();
+ }
+ if (attributes.Count > 0) {
+ xpath += "[" + string.Join (" and ", attributes.ToArray ()) + "]";
+ }
+ XmlNode doc = e.SelectSingleNode (xpath);
+ string value = ecmadocs.ReadInnerXml ().Replace ("\r", "");
+ if (doc != null) {
+ doc.InnerXml = value;
+ }
+ else {
+ XmlElement n = e.OwnerDocument.CreateElement (name);
+ n.InnerXml = value;
+ foreach (string a in attributes) {
+ int eq = a.IndexOf ('=');
+ n.SetAttribute (a.Substring (1, eq-1), a.Substring (eq+2, a.Length-eq-3));
+ }
+ e.AppendChild (n);
+ }
+ break;
+ }
}
- else
- baseRef = null;
}
- foreach (TypeReference r in type.Interfaces)
- a (r.Resolve ());
- return inheritedInterfaces;
}
}
}
}
-public enum MemberFormatterState {
- None,
- WithinArray,
- WithinGenericTypeContainer,
-}
+public class DynamicParserContext {
+ public ReadOnlyCollection<bool> TransformFlags;
+ public int TransformIndex;
+
+ public DynamicParserContext (ICustomAttributeProvider provider)
+ {
+ CustomAttribute da;
+ if (provider.HasCustomAttributes &&
+ (da = (provider.CustomAttributes.Cast<CustomAttribute>()
+ .SingleOrDefault (ca => ca.GetDeclaringType() == "System.Runtime.CompilerServices.DynamicAttribute"))) != null) {
+ CustomAttributeArgument[] values = da.ConstructorArguments.Count == 0
+ ? new CustomAttributeArgument [0]
+ : (CustomAttributeArgument[]) da.ConstructorArguments [0].Value;
+
+ TransformFlags = new ReadOnlyCollection<bool> (values.Select (t => (bool) t.Value).ToArray());
+ }
+ }
+}
+
+public enum MemberFormatterState {
+ None,
+ WithinGenericTypeParameters,
+}
+
+public abstract class MemberFormatter {
+
+ public virtual string Language {
+ get {return "";}
+ }
+
+ public string GetName (MemberReference member)
+ {
+ return GetName (member, null);
+ }
-public abstract class MemberFormatter {
- public virtual string GetName (IMemberReference member)
+ public virtual string GetName (MemberReference member, DynamicParserContext context)
{
TypeReference type = member as TypeReference;
if (type != null)
- return GetTypeName (type);
+ return GetTypeName (type, context);
MethodReference method = member as MethodReference;
if (method != null && method.Name == ".ctor") // method.IsConstructor
return GetConstructorName (method);
}
protected virtual string GetTypeName (TypeReference type)
+ {
+ return GetTypeName (type, null);
+ }
+
+ protected virtual string GetTypeName (TypeReference type, DynamicParserContext context)
{
if (type == null)
throw new ArgumentNullException ("type");
- return _AppendTypeName (new StringBuilder (type.Name.Length), type).ToString ();
+ return _AppendTypeName (new StringBuilder (type.Name.Length), type, context).ToString ();
}
protected virtual char[] ArrayDelimeters {
protected virtual MemberFormatterState MemberFormatterState { get; set; }
- protected StringBuilder _AppendTypeName (StringBuilder buf, TypeReference type)
+ protected StringBuilder _AppendTypeName (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
if (type is ArrayType) {
TypeSpecification spec = type as TypeSpecification;
- _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetOriginalType ())
- .Append (ArrayDelimeters [0]);
- var origState = MemberFormatterState;
- MemberFormatterState = MemberFormatterState.WithinArray;
- ArrayType array = (ArrayType) type;
- int rank = array.Rank;
- if (rank > 1)
- buf.Append (new string (',', rank-1));
- MemberFormatterState = origState;
- return buf.Append (ArrayDelimeters [1]);
- }
- if (type is ReferenceType) {
- return AppendRefTypeName (buf, type);
+ _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetElementType (), context);
+ return AppendArrayModifiers (buf, (ArrayType) type);
+ }
+ if (type is ByReferenceType) {
+ return AppendRefTypeName (buf, type, context);
}
if (type is PointerType) {
- return AppendPointerTypeName (buf, type);
+ return AppendPointerTypeName (buf, type, context);
}
AppendNamespace (buf, type);
if (type is GenericParameter) {
- return AppendTypeName (buf, type);
+ return AppendTypeName (buf, type, context);
}
GenericInstanceType genInst = type as GenericInstanceType;
if (type.GenericParameters.Count == 0 &&
(genInst == null ? true : genInst.GenericArguments.Count == 0)) {
- return AppendFullTypeName (buf, type);
+ return AppendFullTypeName (buf, type, context);
}
- return AppendGenericType (buf, type);
+ return AppendGenericType (buf, type, context);
}
protected virtual StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
return buf;
}
- private StringBuilder AppendFullTypeName (StringBuilder buf, TypeReference type)
+ protected virtual StringBuilder AppendFullTypeName (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
if (type.DeclaringType != null)
- AppendFullTypeName (buf, type.DeclaringType).Append (NestedTypeSeparator);
- return AppendTypeName (buf, type);
+ AppendFullTypeName (buf, type.DeclaringType, context).Append (NestedTypeSeparator);
+ return AppendTypeName (buf, type, context);
}
- protected virtual StringBuilder AppendTypeName (StringBuilder buf, TypeReference type)
+ protected virtual StringBuilder AppendTypeName (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
+ if (context != null)
+ context.TransformIndex++;
return AppendTypeName (buf, type.Name);
}
return buf.Append (typename);
}
+ protected virtual StringBuilder AppendArrayModifiers (StringBuilder buf, ArrayType array)
+ {
+ buf.Append (ArrayDelimeters [0]);
+ int rank = array.Rank;
+ if (rank > 1)
+ buf.Append (new string (',', rank-1));
+ return buf.Append (ArrayDelimeters [1]);
+ }
+
protected virtual string RefTypeModifier {
get {return "@";}
}
- protected virtual StringBuilder AppendRefTypeName (StringBuilder buf, TypeReference type)
+ protected virtual StringBuilder AppendRefTypeName (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
TypeSpecification spec = type as TypeSpecification;
- return _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetOriginalType ())
+ return _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetElementType (), context)
.Append (RefTypeModifier);
}
get {return "*";}
}
- protected virtual StringBuilder AppendPointerTypeName (StringBuilder buf, TypeReference type)
+ protected virtual StringBuilder AppendPointerTypeName (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
TypeSpecification spec = type as TypeSpecification;
- return _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetOriginalType ())
+ return _AppendTypeName (buf, spec != null ? spec.ElementType : type.GetElementType (), context)
.Append (PointerModifier);
}
get {return '.';}
}
- protected virtual StringBuilder AppendGenericType (StringBuilder buf, TypeReference type)
+ protected virtual StringBuilder AppendGenericType (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
List<TypeReference> decls = DocUtils.GetDeclaringTypes (
- type is GenericInstanceType ? type.GetOriginalType () : type);
+ type is GenericInstanceType ? type.GetElementType () : type);
List<TypeReference> genArgs = GetGenericArguments (type);
int argIdx = 0;
int prev = 0;
buf.Append (NestedTypeSeparator);
}
insertNested = true;
- AppendTypeName (buf, declDef);
+ AppendTypeName (buf, declDef, context);
int ac = DocUtils.GetGenericArgumentCount (declDef);
int c = ac - prev;
prev = ac;
if (c > 0) {
buf.Append (GenericTypeContainer [0]);
var origState = MemberFormatterState;
- MemberFormatterState = MemberFormatterState.WithinGenericTypeContainer;
- _AppendTypeName (buf, genArgs [argIdx++]);
- for (int i = 1; i < c; ++i)
- _AppendTypeName (buf.Append (","), genArgs [argIdx++]);
+ MemberFormatterState = MemberFormatterState.WithinGenericTypeParameters;
+ _AppendTypeName (buf, genArgs [argIdx++], context);
+ for (int i = 1; i < c; ++i) {
+ _AppendTypeName (buf.Append (","), genArgs [argIdx++], context);
+ }
MemberFormatterState = origState;
buf.Append (GenericTypeContainer [1]);
}
}
- return buf;
+ return buf;
+ }
+
+ protected List<TypeReference> GetGenericArguments (TypeReference type)
+ {
+ var args = new List<TypeReference> ();
+ GenericInstanceType inst = type as GenericInstanceType;
+ if (inst != null)
+ args.AddRange (inst.GenericArguments.Cast<TypeReference> ());
+ else
+ args.AddRange (type.GenericParameters.Cast<TypeReference> ());
+ return args;
+ }
+
+ protected virtual StringBuilder AppendGenericTypeConstraints (StringBuilder buf, TypeReference type)
+ {
+ return buf;
+ }
+
+ protected virtual string GetConstructorName (MethodReference constructor)
+ {
+ return constructor.Name;
+ }
+
+ protected virtual string GetMethodName (MethodReference method)
+ {
+ return method.Name;
+ }
+
+ protected virtual string GetPropertyName (PropertyReference property)
+ {
+ return property.Name;
+ }
+
+ protected virtual string GetFieldName (FieldReference field)
+ {
+ return field.Name;
+ }
+
+ protected virtual string GetEventName (EventReference e)
+ {
+ return e.Name;
+ }
+
+ public virtual string GetDeclaration (MemberReference member)
+ {
+ if (member == null)
+ throw new ArgumentNullException ("member");
+ TypeDefinition type = member as TypeDefinition;
+ if (type != null)
+ return GetTypeDeclaration (type);
+ MethodDefinition method = member as MethodDefinition;
+ if (method != null && method.IsConstructor)
+ return GetConstructorDeclaration (method);
+ if (method != null)
+ return GetMethodDeclaration (method);
+ PropertyDefinition prop = member as PropertyDefinition;
+ if (prop != null)
+ return GetPropertyDeclaration (prop);
+ FieldDefinition field = member as FieldDefinition;
+ if (field != null)
+ return GetFieldDeclaration (field);
+ EventDefinition e = member as EventDefinition;
+ if (e != null)
+ return GetEventDeclaration (e);
+ throw new NotSupportedException ("Can't handle: " + member.GetType().ToString());
+ }
+
+ protected virtual string GetTypeDeclaration (TypeDefinition type)
+ {
+ if (type == null)
+ throw new ArgumentNullException ("type");
+ StringBuilder buf = new StringBuilder (type.Name.Length);
+ _AppendTypeName (buf, type, null);
+ AppendGenericTypeConstraints (buf, type);
+ return buf.ToString ();
+ }
+
+ protected virtual string GetConstructorDeclaration (MethodDefinition constructor)
+ {
+ return GetConstructorName (constructor);
+ }
+
+ protected virtual string GetMethodDeclaration (MethodDefinition method)
+ {
+ if (method.HasCustomAttributes && method.CustomAttributes.Cast<CustomAttribute>().Any(
+ ca => ca.GetDeclaringType() == "System.Diagnostics.Contracts.ContractInvariantMethodAttribute"))
+ return null;
+
+ // Special signature for destructors.
+ if (method.Name == "Finalize" && method.Parameters.Count == 0)
+ return GetFinalizerName (method);
+
+ StringBuilder buf = new StringBuilder ();
+
+ AppendVisibility (buf, method);
+ if (buf.Length == 0 &&
+ !(DocUtils.IsExplicitlyImplemented (method) && !method.IsSpecialName))
+ return null;
+
+ AppendModifiers (buf, method);
+
+ if (buf.Length != 0)
+ buf.Append (" ");
+ buf.Append (GetTypeName (method.ReturnType, new DynamicParserContext (method.MethodReturnType))).Append (" ");
+
+ AppendMethodName (buf, method);
+ AppendGenericMethod (buf, method).Append (" ");
+ AppendParameters (buf, method, method.Parameters);
+ AppendGenericMethodConstraints (buf, method);
+ return buf.ToString ();
+ }
+
+ protected virtual StringBuilder AppendMethodName (StringBuilder buf, MethodDefinition method)
+ {
+ return buf.Append (method.Name);
+ }
+
+ protected virtual string GetFinalizerName (MethodDefinition method)
+ {
+ return "Finalize";
+ }
+
+ protected virtual StringBuilder AppendVisibility (StringBuilder buf, MethodDefinition method)
+ {
+ return buf;
+ }
+
+ protected virtual StringBuilder AppendModifiers (StringBuilder buf, MethodDefinition method)
+ {
+ return buf;
+ }
+
+ protected virtual StringBuilder AppendGenericMethod (StringBuilder buf, MethodDefinition method)
+ {
+ return buf;
+ }
+
+ protected virtual StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters)
+ {
+ return buf;
+ }
+
+ protected virtual StringBuilder AppendGenericMethodConstraints (StringBuilder buf, MethodDefinition method)
+ {
+ return buf;
+ }
+
+ protected virtual string GetPropertyDeclaration (PropertyDefinition property)
+ {
+ return GetPropertyName (property);
+ }
+
+ protected virtual string GetFieldDeclaration (FieldDefinition field)
+ {
+ return GetFieldName (field);
+ }
+
+ protected virtual string GetEventDeclaration (EventDefinition e)
+ {
+ return GetEventName (e);
+ }
+}
+
+class ILFullMemberFormatter : MemberFormatter {
+
+ public override string Language {
+ get {return "ILAsm";}
+ }
+
+ protected override char NestedTypeSeparator {
+ get {
+ return '/';
+ }
+ }
+
+ protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
+ {
+ if (GetBuiltinType (type.FullName) != null)
+ return buf;
+ string ns = DocUtils.GetNamespace (type);
+ if (ns != null && ns.Length > 0) {
+ if (type.IsValueType)
+ buf.Append ("valuetype ");
+ else
+ buf.Append ("class ");
+ buf.Append (ns).Append ('.');
+ }
+ return buf;
+ }
+
+ private static string GetBuiltinType (string t)
+ {
+ switch (t) {
+ case "System.Byte": return "unsigned int8";
+ case "System.SByte": return "int8";
+ case "System.Int16": return "int16";
+ case "System.Int32": return "int32";
+ case "System.Int64": return "int64";
+ case "System.IntPtr": return "native int";
+
+ case "System.UInt16": return "unsigned int16";
+ case "System.UInt32": return "unsigned int32";
+ case "System.UInt64": return "unsigned int64";
+ case "System.UIntPtr": return "native unsigned int";
+
+ case "System.Single": return "float32";
+ case "System.Double": return "float64";
+ case "System.Boolean": return "bool";
+ case "System.Char": return "char";
+ case "System.Void": return "void";
+ case "System.String": return "string";
+ case "System.Object": return "object";
+ }
+ return null;
+ }
+
+ protected override StringBuilder AppendTypeName (StringBuilder buf, string typename)
+ {
+ return buf.Append (typename);
+ }
+
+ protected override StringBuilder AppendTypeName (StringBuilder buf, TypeReference type, DynamicParserContext context)
+ {
+ if (type is GenericParameter) {
+ AppendGenericParameterConstraints (buf, (GenericParameter) type).Append (type.Name);
+ return buf;
+ }
+
+ string s = GetBuiltinType (type.FullName);
+ if (s != null) {
+ return buf.Append (s);
+ }
+ return base.AppendTypeName (buf, type, context);
+ }
+
+ private StringBuilder AppendGenericParameterConstraints (StringBuilder buf, GenericParameter type)
+ {
+ if (MemberFormatterState != MemberFormatterState.WithinGenericTypeParameters) {
+ return buf.Append (type.Owner is TypeReference ? "!" : "!!");
+ }
+ GenericParameterAttributes attrs = type.Attributes;
+ if ((attrs & GenericParameterAttributes.ReferenceTypeConstraint) != 0)
+ buf.Append ("class ");
+ if ((attrs & GenericParameterAttributes.NotNullableValueTypeConstraint) != 0)
+ buf.Append ("struct ");
+ if ((attrs & GenericParameterAttributes.DefaultConstructorConstraint) != 0)
+ buf.Append (".ctor ");
+ IList<TypeReference> constraints = type.Constraints;
+ MemberFormatterState = 0;
+ if (constraints.Count > 0) {
+ var full = new ILFullMemberFormatter ();
+ buf.Append ("(").Append (full.GetName (constraints [0]));
+ for (int i = 1; i < constraints.Count; ++i) {
+ buf.Append (", ").Append (full.GetName (constraints [i]));
+ }
+ buf.Append (") ");
+ }
+ MemberFormatterState = MemberFormatterState.WithinGenericTypeParameters;
+
+ if ((attrs & GenericParameterAttributes.Covariant) != 0)
+ buf.Append ("+ ");
+ if ((attrs & GenericParameterAttributes.Contravariant) != 0)
+ buf.Append ("- ");
+ return buf;
+ }
+
+ protected override string GetTypeDeclaration (TypeDefinition type)
+ {
+ string visibility = GetTypeVisibility (type.Attributes);
+ if (visibility == null)
+ return null;
+
+ StringBuilder buf = new StringBuilder ();
+
+ buf.Append (".class ");
+ if (type.IsNested)
+ buf.Append ("nested ");
+ buf.Append (visibility).Append (" ");
+ if (type.IsInterface)
+ buf.Append ("interface ");
+ if (type.IsSequentialLayout)
+ buf.Append ("sequential ");
+ if (type.IsAutoLayout)
+ buf.Append ("auto ");
+ if (type.IsAnsiClass)
+ buf.Append ("ansi ");
+ if (type.IsAbstract)
+ buf.Append ("abstract ");
+ if (type.IsSerializable)
+ buf.Append ("serializable ");
+ if (type.IsSealed)
+ buf.Append ("sealed ");
+ if (type.IsBeforeFieldInit)
+ buf.Append ("beforefieldinit ");
+ var state = MemberFormatterState;
+ MemberFormatterState = MemberFormatterState.WithinGenericTypeParameters;
+ buf.Append (GetName (type));
+ MemberFormatterState = state;
+ var full = new ILFullMemberFormatter ();
+ if (type.BaseType != null) {
+ buf.Append (" extends ");
+ if (type.BaseType.FullName == "System.Object")
+ buf.Append ("System.Object");
+ else
+ buf.Append (full.GetName (type.BaseType).Substring ("class ".Length));
+ }
+ bool first = true;
+ foreach (var name in type.Interfaces
+ .Select (i => full.GetName (i))
+ .OrderBy (n => n)) {
+ if (first) {
+ buf.Append (" implements ");
+ first = false;
+ }
+ else {
+ buf.Append (", ");
+ }
+ buf.Append (name);
+ }
+
+ return buf.ToString ();
+ }
+
+ protected override StringBuilder AppendGenericType (StringBuilder buf, TypeReference type, DynamicParserContext context)
+ {
+ List<TypeReference> decls = DocUtils.GetDeclaringTypes (
+ type is GenericInstanceType ? type.GetElementType () : type);
+ bool first = true;
+ foreach (var decl in decls) {
+ TypeReference declDef = decl.Resolve () ?? decl;
+ if (!first) {
+ buf.Append (NestedTypeSeparator);
+ }
+ first = false;
+ AppendTypeName (buf, declDef, context);
+ }
+ buf.Append ('<');
+ first = true;
+ foreach (TypeReference arg in GetGenericArguments (type)) {
+ if (!first)
+ buf.Append (", ");
+ first = false;
+ _AppendTypeName (buf, arg, context);
+ }
+ buf.Append ('>');
+ return buf;
+ }
+
+ static string GetTypeVisibility (TypeAttributes ta)
+ {
+ switch (ta & TypeAttributes.VisibilityMask) {
+ case TypeAttributes.Public:
+ case TypeAttributes.NestedPublic:
+ return "public";
+
+ case TypeAttributes.NestedFamily:
+ case TypeAttributes.NestedFamORAssem:
+ return "protected";
+
+ default:
+ return null;
+ }
}
- private List<TypeReference> GetGenericArguments (TypeReference type)
+ protected override string GetConstructorDeclaration (MethodDefinition constructor)
{
- var args = new List<TypeReference> ();
- GenericInstanceType inst = type as GenericInstanceType;
- if (inst != null)
- args.AddRange (inst.GenericArguments.Cast<TypeReference> ());
- else
- args.AddRange (type.GenericParameters.Cast<TypeReference> ());
- return args;
+ return GetMethodDeclaration (constructor);
}
- protected virtual StringBuilder AppendGenericTypeConstraints (StringBuilder buf, TypeReference type)
+ protected override string GetMethodDeclaration (MethodDefinition method)
{
- return buf;
+ if (method.IsPrivate && !DocUtils.IsExplicitlyImplemented (method))
+ return null;
+
+ var buf = new StringBuilder ();
+ buf.Append (".method ");
+ AppendVisibility (buf, method);
+ if (method.IsStatic)
+ buf.Append ("static ");
+ if (method.IsHideBySig)
+ buf.Append ("hidebysig ");
+ if (method.IsPInvokeImpl) {
+ var info = method.PInvokeInfo;
+ buf.Append ("pinvokeimpl (\"")
+ .Append (info.Module.Name)
+ .Append ("\" as \"")
+ .Append (info.EntryPoint)
+ .Append ("\"");
+ if (info.IsCharSetAuto)
+ buf.Append (" auto");
+ if (info.IsCharSetUnicode)
+ buf.Append (" unicode");
+ if (info.IsCharSetAnsi)
+ buf.Append (" ansi");
+ if (info.IsCallConvCdecl)
+ buf.Append (" cdecl");
+ if (info.IsCallConvStdCall)
+ buf.Append (" stdcall");
+ if (info.IsCallConvWinapi)
+ buf.Append (" winapi");
+ if (info.IsCallConvThiscall)
+ buf.Append (" thiscall");
+ if (info.SupportsLastError)
+ buf.Append (" lasterr");
+ buf.Append (")");
+ }
+ if (method.IsSpecialName)
+ buf.Append ("specialname ");
+ if (method.IsRuntimeSpecialName)
+ buf.Append ("rtspecialname ");
+ if (method.IsNewSlot)
+ buf.Append ("newslot ");
+ if (method.IsVirtual)
+ buf.Append ("virtual ");
+ if (!method.IsStatic)
+ buf.Append ("instance ");
+ _AppendTypeName (buf, method.ReturnType, new DynamicParserContext (method.MethodReturnType));
+ buf.Append (' ')
+ .Append (method.Name);
+ if (method.IsGenericMethod ()) {
+ var state = MemberFormatterState;
+ MemberFormatterState = MemberFormatterState.WithinGenericTypeParameters;
+ IList<GenericParameter> args = method.GenericParameters;
+ if (args.Count > 0) {
+ buf.Append ("<");
+ _AppendTypeName (buf, args [0], null);
+ for (int i = 1; i < args.Count; ++i)
+ _AppendTypeName (buf.Append (", "), args [i], null);
+ buf.Append (">");
+ }
+ MemberFormatterState = state;
+ }
+
+ buf.Append ('(');
+ bool first = true;
+ for (int i = 0; i < method.Parameters.Count; ++i) {
+ if (!first)
+ buf.Append (", ");
+ first = false;
+ _AppendTypeName (buf, method.Parameters [i].ParameterType, new DynamicParserContext (method.Parameters [i]));
+ buf.Append (' ');
+ buf.Append (method.Parameters [i].Name);
+ }
+ buf.Append (')');
+ if (method.IsIL)
+ buf.Append (" cil");
+ if (method.IsRuntime)
+ buf.Append (" runtime");
+ if (method.IsManaged)
+ buf.Append (" managed");
+
+ return buf.ToString ();
}
- protected virtual string GetConstructorName (MethodReference constructor)
+ protected override StringBuilder AppendMethodName (StringBuilder buf, MethodDefinition method)
{
- return constructor.Name;
+ if (DocUtils.IsExplicitlyImplemented (method)) {
+ TypeReference iface;
+ MethodReference ifaceMethod;
+ DocUtils.GetInfoForExplicitlyImplementedMethod (method, out iface, out ifaceMethod);
+ return buf.Append (new CSharpMemberFormatter ().GetName (iface))
+ .Append ('.')
+ .Append (ifaceMethod.Name);
+ }
+ return base.AppendMethodName (buf, method);
}
- protected virtual string GetMethodName (MethodReference method)
- {
- return method.Name;
+ protected override string RefTypeModifier {
+ get {return "";}
}
- protected virtual string GetPropertyName (PropertyReference property)
+ protected override StringBuilder AppendVisibility (StringBuilder buf, MethodDefinition method)
{
- return property.Name;
+ if (method.IsPublic)
+ return buf.Append ("public ");
+ if (method.IsFamilyAndAssembly)
+ return buf.Append ("familyandassembly");
+ if (method.IsFamilyOrAssembly)
+ return buf.Append ("familyorassembly");
+ if (method.IsFamily)
+ return buf.Append ("family");
+ return buf;
}
- protected virtual string GetFieldName (FieldReference field)
+ protected override StringBuilder AppendModifiers (StringBuilder buf, MethodDefinition method)
{
- return field.Name;
+ string modifiers = String.Empty;
+ if (method.IsStatic) modifiers += " static";
+ if (method.IsVirtual && !method.IsAbstract) {
+ if ((method.Attributes & MethodAttributes.NewSlot) != 0) modifiers += " virtual";
+ else modifiers += " override";
+ }
+ TypeDefinition declType = (TypeDefinition) method.DeclaringType;
+ if (method.IsAbstract && !declType.IsInterface) modifiers += " abstract";
+ if (method.IsFinal) modifiers += " sealed";
+ if (modifiers == " virtual sealed") modifiers = "";
+
+ return buf.Append (modifiers);
}
- protected virtual string GetEventName (EventReference e)
+ protected override StringBuilder AppendGenericMethod (StringBuilder buf, MethodDefinition method)
{
- return e.Name;
+ if (method.IsGenericMethod ()) {
+ IList<GenericParameter> args = method.GenericParameters;
+ if (args.Count > 0) {
+ buf.Append ("<");
+ buf.Append (args [0].Name);
+ for (int i = 1; i < args.Count; ++i)
+ buf.Append (",").Append (args [i].Name);
+ buf.Append (">");
+ }
+ }
+ return buf;
}
- public virtual string GetDeclaration (IMemberReference member)
+ protected override StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters)
{
- if (member == null)
- throw new ArgumentNullException ("member");
- TypeDefinition type = member as TypeDefinition;
- if (type != null)
- return GetTypeDeclaration (type);
- MethodDefinition method = member as MethodDefinition;
- if (method != null && method.IsConstructor)
- return GetConstructorDeclaration (method);
- if (method != null)
- return GetMethodDeclaration (method);
- PropertyDefinition prop = member as PropertyDefinition;
- if (prop != null)
- return GetPropertyDeclaration (prop);
- FieldDefinition field = member as FieldDefinition;
- if (field != null)
- return GetFieldDeclaration (field);
- EventDefinition e = member as EventDefinition;
- if (e != null)
- return GetEventDeclaration (e);
- throw new NotSupportedException ("Can't handle: " + member.GetType().ToString());
+ return AppendParameters (buf, method, parameters, '(', ')');
}
- protected virtual string GetTypeDeclaration (TypeDefinition type)
+ private StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters, char begin, char end)
{
- if (type == null)
- throw new ArgumentNullException ("type");
- StringBuilder buf = new StringBuilder (type.Name.Length);
- _AppendTypeName (buf, type);
- AppendGenericTypeConstraints (buf, type);
- return buf.ToString ();
+ buf.Append (begin);
+
+ if (parameters.Count > 0) {
+ if (DocUtils.IsExtensionMethod (method))
+ buf.Append ("this ");
+ AppendParameter (buf, parameters [0]);
+ for (int i = 1; i < parameters.Count; ++i) {
+ buf.Append (", ");
+ AppendParameter (buf, parameters [i]);
+ }
+ }
+
+ return buf.Append (end);
}
- protected virtual string GetConstructorDeclaration (MethodDefinition constructor)
+ private StringBuilder AppendParameter (StringBuilder buf, ParameterDefinition parameter)
{
- return GetConstructorName (constructor);
+ if (parameter.ParameterType is ByReferenceType) {
+ if (parameter.IsOut)
+ buf.Append ("out ");
+ else
+ buf.Append ("ref ");
+ }
+ buf.Append (GetName (parameter.ParameterType)).Append (" ");
+ return buf.Append (parameter.Name);
}
- protected virtual string GetMethodDeclaration (MethodDefinition method)
+ protected override string GetPropertyDeclaration (PropertyDefinition property)
{
- // Special signature for destructors.
- if (method.Name == "Finalize" && method.Parameters.Count == 0)
- return GetFinalizerName (method);
+ MethodDefinition gm = null, sm = null;
- StringBuilder buf = new StringBuilder ();
+ string get_visible = null;
+ if ((gm = property.GetMethod) != null &&
+ (DocUtils.IsExplicitlyImplemented (gm) ||
+ (!gm.IsPrivate && !gm.IsAssembly && !gm.IsFamilyAndAssembly)))
+ get_visible = AppendVisibility (new StringBuilder (), gm).ToString ();
+ string set_visible = null;
+ if ((sm = property.SetMethod) != null &&
+ (DocUtils.IsExplicitlyImplemented (sm) ||
+ (!sm.IsPrivate && !sm.IsAssembly && !sm.IsFamilyAndAssembly)))
+ set_visible = AppendVisibility (new StringBuilder (), sm).ToString ();
- AppendVisibility (buf, method);
- if (buf.Length == 0 &&
- !(DocUtils.IsExplicitlyImplemented (method) && !method.IsSpecialName))
+ if ((set_visible == null) && (get_visible == null))
return null;
- AppendModifiers (buf, method);
+ StringBuilder buf = new StringBuilder ()
+ .Append (".property ");
+ if (!(gm ?? sm).IsStatic)
+ buf.Append ("instance ");
+ _AppendTypeName (buf, property.PropertyType, new DynamicParserContext (property));
+ buf.Append (' ').Append (property.Name);
+ if (!property.HasParameters || property.Parameters.Count == 0)
+ return buf.ToString ();
- if (buf.Length != 0)
- buf.Append (" ");
- buf.Append (GetName (method.ReturnType.ReturnType)).Append (" ");
+ buf.Append ('(');
+ bool first = true;
+ foreach (ParameterDefinition p in property.Parameters) {
+ if (!first)
+ buf.Append (", ");
+ first = false;
+ _AppendTypeName (buf, p.ParameterType, new DynamicParserContext (p));
+ }
+ buf.Append (')');
- AppendMethodName (buf, method);
- AppendGenericMethod (buf, method).Append (" ");
- AppendParameters (buf, method, method.Parameters);
- AppendGenericMethodConstraints (buf, method);
return buf.ToString ();
}
- protected virtual StringBuilder AppendMethodName (StringBuilder buf, MethodDefinition method)
+ protected override string GetFieldDeclaration (FieldDefinition field)
{
- return buf.Append (method.Name);
- }
+ TypeDefinition declType = (TypeDefinition) field.DeclaringType;
+ if (declType.IsEnum && field.Name == "value__")
+ return null; // This member of enums aren't documented.
- protected virtual string GetFinalizerName (MethodDefinition method)
- {
- return "Finalize";
- }
+ StringBuilder buf = new StringBuilder ();
+ AppendFieldVisibility (buf, field);
+ if (buf.Length == 0)
+ return null;
- protected virtual StringBuilder AppendVisibility (StringBuilder buf, MethodDefinition method)
- {
- return buf;
- }
+ buf.Insert (0, ".field ");
- protected virtual StringBuilder AppendModifiers (StringBuilder buf, MethodDefinition method)
- {
- return buf;
- }
+ if (field.IsStatic)
+ buf.Append ("static ");
+ if (field.IsInitOnly)
+ buf.Append ("initonly ");
+ if (field.IsLiteral)
+ buf.Append ("literal ");
+ _AppendTypeName (buf, field.FieldType, new DynamicParserContext (field));
+ buf.Append (' ').Append (field.Name);
+ AppendFieldValue (buf, field);
- protected virtual StringBuilder AppendGenericMethod (StringBuilder buf, MethodDefinition method)
- {
- return buf;
+ return buf.ToString ();
}
- protected virtual StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, ParameterDefinitionCollection parameters)
+ static StringBuilder AppendFieldVisibility (StringBuilder buf, FieldDefinition field)
{
+ if (field.IsPublic)
+ return buf.Append ("public ");
+ if (field.IsFamilyAndAssembly)
+ return buf.Append ("familyandassembly ");
+ if (field.IsFamilyOrAssembly)
+ return buf.Append ("familyorassembly ");
+ if (field.IsFamily)
+ return buf.Append ("family ");
return buf;
}
- protected virtual StringBuilder AppendGenericMethodConstraints (StringBuilder buf, MethodDefinition method)
+ static StringBuilder AppendFieldValue (StringBuilder buf, FieldDefinition field)
{
+ // enums have a value__ field, which we ignore
+ if (field.DeclaringType.IsGenericType ())
+ return buf;
+ if (field.HasConstant && field.IsLiteral) {
+ object val = null;
+ try {
+ val = field.Constant;
+ } catch {
+ return buf;
+ }
+ if (val == null)
+ buf.Append (" = ").Append ("null");
+ else if (val is Enum)
+ buf.Append (" = ")
+ .Append (GetBuiltinType (field.DeclaringType.GetUnderlyingType ().FullName))
+ .Append ('(')
+ .Append (val.ToString ())
+ .Append (')');
+ else if (val is IFormattable) {
+ string value = ((IFormattable)val).ToString();
+ buf.Append (" = ");
+ if (val is string)
+ buf.Append ("\"" + value + "\"");
+ else
+ buf.Append (GetBuiltinType (field.DeclaringType.GetUnderlyingType ().FullName))
+ .Append ('(')
+ .Append (value)
+ .Append (')');
+ }
+ }
return buf;
}
- protected virtual string GetPropertyDeclaration (PropertyDefinition property)
+ protected override string GetEventDeclaration (EventDefinition e)
{
- return GetPropertyName (property);
- }
+ StringBuilder buf = new StringBuilder ();
+ if (AppendVisibility (buf, e.AddMethod).Length == 0) {
+ return null;
+ }
- protected virtual string GetFieldDeclaration (FieldDefinition field)
- {
- return GetFieldName (field);
+ buf.Length = 0;
+ buf.Append (".event ")
+ .Append (GetName (e.EventType))
+ .Append (' ')
+ .Append (e.Name);
+
+ return buf.ToString ();
}
+}
- protected virtual string GetEventDeclaration (EventDefinition e)
+class ILMemberFormatter : ILFullMemberFormatter {
+ protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
{
- return GetEventName (e);
+ return buf;
}
}
class CSharpFullMemberFormatter : MemberFormatter {
+ public override string Language {
+ get {return "C#";}
+ }
+
protected override StringBuilder AppendNamespace (StringBuilder buf, TypeReference type)
{
string ns = DocUtils.GetNamespace (type);
return null;
}
- protected override StringBuilder AppendTypeName (StringBuilder buf, TypeReference type)
+ protected override StringBuilder AppendTypeName (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
+ if (context != null && context.TransformFlags != null &&
+ (context.TransformFlags.Count == 0 || context.TransformFlags [context.TransformIndex])) {
+ context.TransformIndex++;
+ return buf.Append ("dynamic");
+ }
+
if (type is GenericParameter)
- return AppendGenericParameterConstraints (buf, (GenericParameter) type).Append (type.Name);
+ return AppendGenericParameterConstraints (buf, (GenericParameter) type, context).Append (type.Name);
string t = type.FullName;
if (!t.StartsWith ("System.")) {
- return base.AppendTypeName (buf, type);
+ return base.AppendTypeName (buf, type, context);
}
string s = GetCSharpType (t);
- if (s != null)
+ if (s != null) {
+ if (context != null)
+ context.TransformIndex++;
return buf.Append (s);
+ }
- return base.AppendTypeName (buf, type);
+ return base.AppendTypeName (buf, type, context);
}
- private StringBuilder AppendGenericParameterConstraints (StringBuilder buf, GenericParameter type)
+ private StringBuilder AppendGenericParameterConstraints (StringBuilder buf, GenericParameter type, DynamicParserContext context)
{
- if (MemberFormatterState != MemberFormatterState.WithinGenericTypeContainer)
+ if (MemberFormatterState != MemberFormatterState.WithinGenericTypeParameters)
return buf;
GenericParameterAttributes attrs = type.Attributes;
bool isout = (attrs & GenericParameterAttributes.Covariant) != 0;
if (DocUtils.IsDelegate (type)) {
buf.Append("delegate ");
MethodDefinition invoke = type.GetMethod ("Invoke");
- buf.Append (full.GetName (invoke.ReturnType.ReturnType)).Append (" ");
+ buf.Append (full.GetName (invoke.ReturnType, new DynamicParserContext (invoke.MethodReturnType))).Append (" ");
buf.Append (GetName (type));
AppendParameters (buf, invoke, invoke.Parameters);
AppendGenericTypeConstraints (buf, type);
return AppendConstraints (buf, type.GenericParameters);
}
- private StringBuilder AppendConstraints (StringBuilder buf, GenericParameterCollection genArgs)
+ private StringBuilder AppendConstraints (StringBuilder buf, IList<GenericParameter> genArgs)
{
foreach (GenericParameter genArg in genArgs) {
GenericParameterAttributes attrs = genArg.Attributes;
- ConstraintCollection constraints = genArg.Constraints;
+ IList<TypeReference> constraints = genArg.Constraints;
if (attrs == GenericParameterAttributes.NonVariant && constraints.Count == 0)
continue;
protected override StringBuilder AppendGenericMethod (StringBuilder buf, MethodDefinition method)
{
if (method.IsGenericMethod ()) {
- GenericParameterCollection args = method.GenericParameters;
+ IList<GenericParameter> args = method.GenericParameters;
if (args.Count > 0) {
buf.Append ("<");
buf.Append (args [0].Name);
return buf;
}
- protected override StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, ParameterDefinitionCollection parameters)
+ protected override StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters)
{
return AppendParameters (buf, method, parameters, '(', ')');
}
- private StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, ParameterDefinitionCollection parameters, char begin, char end)
+ private StringBuilder AppendParameters (StringBuilder buf, MethodDefinition method, IList<ParameterDefinition> parameters, char begin, char end)
{
buf.Append (begin);
private StringBuilder AppendParameter (StringBuilder buf, ParameterDefinition parameter)
{
- if (parameter.ParameterType is ReferenceType) {
+ if (parameter.ParameterType is ByReferenceType) {
if (parameter.IsOut)
buf.Append ("out ");
else
buf.Append ("ref ");
}
- buf.Append (GetName (parameter.ParameterType)).Append (" ");
- return buf.Append (parameter.Name);
+ buf.Append (GetTypeName (parameter.ParameterType, new DynamicParserContext (parameter))).Append (" ");
+ buf.Append (parameter.Name);
+ if (parameter.HasDefault && parameter.IsOptional && parameter.HasConstant) {
+ buf.AppendFormat (" = {0}", MDocUpdater.MakeAttributesValueString (parameter.Constant, parameter.ParameterType));
+ }
+ return buf;
}
protected override string GetPropertyDeclaration (PropertyDefinition property)
modifiers = "";
buf.Append (modifiers).Append (' ');
- buf.Append (GetName (property.PropertyType)).Append (' ');
+ buf.Append (GetTypeName (property.PropertyType, new DynamicParserContext (property))).Append (' ');
- IEnumerable<IMemberReference> defs = property.DeclaringType.GetDefaultMembers ();
+ IEnumerable<MemberReference> defs = property.DeclaringType.GetDefaultMembers ();
string name = property.Name;
- foreach (IMemberReference mi in defs) {
+ foreach (MemberReference mi in defs) {
if (mi == property) {
name = "this";
break;
}
buf.Append (" {");
- if (set_visible != null) {
- if (set_visible != visibility)
- buf.Append (' ').Append (set_visible);
- buf.Append (" set;");
- }
if (get_visible != null) {
if (get_visible != visibility)
buf.Append (' ').Append (get_visible);
buf.Append (" get;");
}
+ if (set_visible != null) {
+ if (set_visible != visibility)
+ buf.Append (' ').Append (set_visible);
+ buf.Append (" set;");
+ }
buf.Append (" }");
return buf [0] != ' ' ? buf.ToString () : buf.ToString (1, buf.Length-1);
if (field.IsLiteral)
buf.Append (" const");
- buf.Append (' ').Append (GetName (field.FieldType)).Append (' ');
+ buf.Append (' ').Append (GetTypeName (field.FieldType, new DynamicParserContext (field))).Append (' ');
buf.Append (field.Name);
AppendFieldValue (buf, field);
buf.Append (';');
AppendModifiers (buf, e.AddMethod);
buf.Append (" event ");
- buf.Append (GetName (e.EventType)).Append (' ');
+ buf.Append (GetTypeName (e.EventType, new DynamicParserContext (e.AddMethod.Parameters [0]))).Append (' ');
buf.Append (e.Name).Append (';');
return buf.ToString ();
private TypeReference genDeclType;
private MethodReference genDeclMethod;
- protected override StringBuilder AppendTypeName (StringBuilder buf, TypeReference type)
+ protected override StringBuilder AppendTypeName (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
if (type is GenericParameter) {
int l = buf.Length;
if (genDeclType != null) {
- GenericParameterCollection genArgs = genDeclType.GenericParameters;
+ IList<GenericParameter> genArgs = genDeclType.GenericParameters;
for (int i = 0; i < genArgs.Count; ++i) {
if (genArgs [i].Name == type.Name) {
buf.Append ('`').Append (i);
}
}
if (genDeclMethod != null) {
- GenericParameterCollection genArgs = null;
+ IList<GenericParameter> genArgs = null;
if (genDeclMethod.IsGenericMethod ()) {
genArgs = genDeclMethod.GenericParameters;
for (int i = 0; i < genArgs.Count; ++i) {
}
}
else {
- base.AppendTypeName (buf, type);
+ base.AppendTypeName (buf, type, context);
if (AddTypeCount) {
int numArgs = type.GenericParameters.Count;
if (type.DeclaringType != null)
return buf;
}
- protected override StringBuilder AppendGenericType (StringBuilder buf, TypeReference type)
+ protected override StringBuilder AppendArrayModifiers (StringBuilder buf, ArrayType array)
+ {
+ buf.Append (ArrayDelimeters [0]);
+ int rank = array.Rank;
+ if (rank > 1) {
+ buf.Append ("0:");
+ for (int i = 1; i < rank; ++i) {
+ buf.Append (",0:");
+ }
+ }
+ return buf.Append (ArrayDelimeters [1]);
+ }
+
+ protected override StringBuilder AppendGenericType (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
if (!AddTypeCount)
- base.AppendGenericType (buf, type);
+ base.AppendGenericType (buf, type, context);
else
- AppendType (buf, type);
+ AppendType (buf, type, context);
return buf;
}
- private StringBuilder AppendType (StringBuilder buf, TypeReference type)
+ private StringBuilder AppendType (StringBuilder buf, TypeReference type, DynamicParserContext context)
{
List<TypeReference> decls = DocUtils.GetDeclaringTypes (type);
bool insertNested = false;
if (insertNested)
buf.Append (NestedTypeSeparator);
insertNested = true;
- base.AppendTypeName (buf, decl);
+ base.AppendTypeName (buf, decl, context);
int argCount = DocUtils.GetGenericArgumentCount (decl);
int numArgs = argCount - prevParamCount;
prevParamCount = argCount;
return buf;
}
- public override string GetDeclaration (IMemberReference member)
+ public override string GetDeclaration (MemberReference member)
{
TypeReference r = member as TypeReference;
if (r != null) {
buf.Append ('.');
buf.Append (name.Replace (".", "#"));
if (method.IsGenericMethod ()) {
- GenericParameterCollection genArgs = method.GenericParameters;
+ IList<GenericParameter> genArgs = method.GenericParameters;
if (genArgs.Count > 0)
buf.Append ("``").Append (genArgs.Count);
}
- ParameterDefinitionCollection parameters = method.Parameters;
+ IList<ParameterDefinition> parameters = method.Parameters;
try {
genDeclType = method.DeclaringType;
genDeclMethod = method;
return buf.ToString ();
}
- private StringBuilder AppendParameters (StringBuilder buf, GenericParameterCollection genArgs, ParameterDefinitionCollection parameters)
+ private StringBuilder AppendParameters (StringBuilder buf, IList<GenericParameter> genArgs, IList<ParameterDefinition> parameters)
{
if (parameters.Count == 0)
return buf;
return buf.Append (')');
}
- private StringBuilder AppendParameter (StringBuilder buf, GenericParameterCollection genArgs, ParameterDefinition parameter)
+ private StringBuilder AppendParameter (StringBuilder buf, IList<GenericParameter> genArgs, ParameterDefinition parameter)
{
AddTypeCount = false;
buf.Append (GetTypeName (parameter.ParameterType));
buf.Append (GetName (property.DeclaringType));
buf.Append ('.');
buf.Append (name);
- ParameterDefinitionCollection parameters = property.Parameters;
+ IList<ParameterDefinition> parameters = property.Parameters;
if (parameters.Count > 0) {
genDeclType = property.DeclaringType;
buf.Append ('(');
- GenericParameterCollection genArgs = property.DeclaringType.GenericParameters;
+ IList<GenericParameter> genArgs = property.DeclaringType.GenericParameters;
AppendParameter (buf, genArgs, parameters [0]);
for (int i = 1; i < parameters.Count; ++i) {
buf.Append (',');
if (method.Name == "op_Implicit" || method.Name == "op_Explicit") {
genDeclType = method.DeclaringType;
genDeclMethod = method;
- name += "~" + GetName (method.ReturnType.ReturnType);
+ name += "~" + GetName (method.ReturnType);
genDeclType = null;
genDeclMethod = null;
}