[mdoc] come up with test/design for better member implementation detection

maopeixia · maopeixia · commit acbdafeec844 · 2020-06-11T14:42:54.000+08:00
diff --git a/mdoc/Mono.Documentation/MDocUpdater.cs b/mdoc/Mono.Documentation/MDocUpdater.cs
@@ -1493,8 +1493,8 @@ public void DoUpdateType2 (string message, XmlDocument basefile, TypeDefinition
         {
             Console.WriteLine (message + ": " + type.FullName);
             StringToXmlNodeMap seenmembers = new StringToXmlNodeMap ();
-            StringToXmlNodeMap seenmembersdocid = new StringToXmlNodeMap();
-
+            StringToXmlNodeMap seenmembersdocid = new StringToXmlNodeMap();
+            var allTypeEiimembers = GetTypeEiiMembers(type);
             // Update type metadata
             UpdateType (basefile.DocumentElement, type, typeEntry);
 
@@ -1649,7 +1649,7 @@ public void DoUpdateType2 (string message, XmlDocument basefile, TypeDefinition
                 }
 
                 // Update signature information
-                UpdateMember (info, typeEntry, implementedMembers);
+                UpdateMember (info, typeEntry, implementedMembers, allTypeEiimembers);
                 memberSet.Add (info.Member.FullName);
 
                 // get all apistyles of sig from info.Node
@@ -1707,7 +1707,7 @@ public void DoUpdateType2 (string message, XmlDocument basefile, TypeDefinition
                         .ToArray();
                 foreach (MemberReference m in typemembers)
                 {
-                    XmlElement mm = MakeMember (basefile, new DocsNodeInfo (null, m), members, typeEntry, implementedMembers);
+                    XmlElement mm = MakeMember (basefile, new DocsNodeInfo (null, m), members, typeEntry, implementedMembers, allTypeEiimembers);
                     if (mm == null) continue;
 
                     if (MDocUpdater.SwitchingToMagicTypes || MDocUpdater.HasDroppedNamespace (m))
@@ -2400,7 +2400,7 @@ internal static IEnumerable<T> Sort<T> (IEnumerable<T> list)
             return l;
         }
 
-        private void UpdateMember (DocsNodeInfo info, FrameworkTypeEntry typeEntry, Dictionary<string, List<MemberReference>> implementedMembers)
+        private void UpdateMember (DocsNodeInfo info, FrameworkTypeEntry typeEntry, Dictionary<string, List<MemberReference>> implementedMembers, IEnumerable<Eiimembers> eiiMenbers)
         {
             XmlElement me = (XmlElement)info.Node;
             MemberReference mi = info.Member;
@@ -2411,7 +2411,7 @@ private void UpdateMember (DocsNodeInfo info, FrameworkTypeEntry typeEntry, Dict
             me.SetAttribute ("MemberName", memberName);
 
             WriteElementText (me, "MemberType", GetMemberType (mi));
-            AddImplementedMembers(typeEntry, mi, implementedMembers, me);
+            AddImplementedMembers(typeEntry, mi, implementedMembers, me, eiiMenbers);
 
             if (!no_assembly_versions)
             {
@@ -2703,7 +2703,7 @@ private static void GetUpdateXmlMethods(MemberFormatter formatter, XmlElement xm
         }
 
 
-        private static void AddImplementedMembers(FrameworkTypeEntry typeEntry, MemberReference mi, Dictionary<string, List<MemberReference>> allImplementedMembers, XmlElement root)
+        public static void AddImplementedMembers(FrameworkTypeEntry typeEntry, MemberReference mi, Dictionary<string, List<MemberReference>> allImplementedMembers, XmlElement root, IEnumerable<Eiimembers> eiiMembers)
         {
             if (typeEntry.TimesProcessed > 1)
                 return;
@@ -2742,6 +2742,45 @@ private static void AddImplementedMembers(FrameworkTypeEntry typeEntry, MemberRe
                 }
             }
 
+            if (!isExplicitlyImplemented)
+            {
+                eiiMembers.Where(x => x.Fingerprint == fingerprint).ToList().ForEach(t =>
+                {
+                    t.Interfaces.ForEach(u =>
+                    {
+                        var delitem = implementedMembers.FirstOrDefault(i =>
+                        {
+                            if (mi is MethodDefinition)
+                            {
+                                MethodDefinition methodDefinition = (MethodDefinition)i;
+                                if (methodDefinition.FullName == u.FullName)
+                                    return true;
+                            }
+
+                            if (mi is PropertyDefinition)
+                            {
+                                PropertyDefinition propertyDefinition = (PropertyDefinition)i;
+                                if (propertyDefinition.GetMethod?.FullName == u.FullName
+                                    || propertyDefinition.SetMethod?.FullName == u.FullName)
+                                    return true;
+                            }
+
+                            if (mi is EventDefinition)
+                            {
+                                EventDefinition evendDefinition = (EventDefinition)i;
+                                if (evendDefinition.AddMethod?.FullName == u.FullName
+                                    || evendDefinition.RemoveMethod?.FullName == u.FullName)
+                                    return true;
+                            }
+                            return false;
+                        });
+
+                        if (delitem != null)
+                            implementedMembers.Remove(delitem);
+                    });
+                });
+            }
+
             if (!implementedMembers.Any())
                 return;
 
@@ -4201,7 +4240,7 @@ private void MakeReturnValue (FrameworkTypeEntry typeEntry, XmlElement root, Mem
                 throw new ArgumentException (mi + " is a " + mi.GetType ().FullName);
         }
 
-        private XmlElement MakeMember (XmlDocument doc, DocsNodeInfo info, XmlNode members, FrameworkTypeEntry typeEntry, Dictionary<string, List<MemberReference>> iplementedMembers)
+        private XmlElement MakeMember (XmlDocument doc, DocsNodeInfo info, XmlNode members, FrameworkTypeEntry typeEntry, Dictionary<string, List<MemberReference>> iplementedMembers, IEnumerable<Eiimembers> eiiMenbers)
         {
             MemberReference mi = info.Member;
             if (mi is TypeDefinition) return null;
@@ -4220,7 +4259,7 @@ private XmlElement MakeMember (XmlDocument doc, DocsNodeInfo info, XmlNode membe
             AddEiiNameAsAttribute(mi, me, memberName);
 
             info.Node = me;
-            UpdateMember (info, typeEntry, iplementedMembers);
+            UpdateMember (info, typeEntry, iplementedMembers, eiiMenbers);
             if (exceptions.HasValue &&
                     (exceptions.Value & ExceptionLocations.AddedMembers) != 0)
                 UpdateExceptions (info.Node, info.Member);
@@ -4420,6 +4459,32 @@ public static string GetXPathForMember (MemberReference member)
         private static IEnumerable<XmlElement> QueryXmlElementsByXpath(XmlElement parentNode, string xPath)
         {
             return parentNode.SelectNodes(xPath).SafeCast<XmlElement>().ToArray();
+        }
+
+        public static IEnumerable<Eiimembers> GetTypeEiiMembers(TypeDefinition type)
+        {
+            if (!DocUtils.IsDelegate(type))
+            {
+                var eiiTypeMembers = type.GetMembers()
+                        .Where(m =>
+                        {
+                            if (m is TypeDefinition) return false;
+                            string cssig = FormatterManager.MemberFormatters[0].GetDeclaration(m);
+                            if (cssig == null) return false;
+
+                            string sig = FormatterManager.MemberFormatters[1].GetDeclaration(m);
+                            if (sig == null) return false;
+
+                            if (!IsMemberNotPrivateEII(m))
+                                return false;
+                            return true;
+                        })
+                        .Where(t => DocUtils.IsExplicitlyImplemented(t))
+                        .Select(t => new Eiimembers { Fingerprint = DocUtils.GetFingerprint(t), Interfaces = DocUtils.GetOverrides(t).ToList<MemberReference>() });
+                return eiiTypeMembers;
+            }
+            else
+            { return new List<Eiimembers>(); }
         }
     }
 }
diff --git a/mdoc/Mono.Documentation/Updater/DocUtils.cs b/mdoc/Mono.Documentation/Updater/DocUtils.cs
@@ -796,7 +796,7 @@ public static bool IsExplicitlyImplemented(MemberReference memberReference)
         /// <summary>
         /// Get which members are overriden by memberReference
         /// </summary>
-        private static Collection<MethodReference> GetOverrides(MemberReference memberReference)
+        public static Collection<MethodReference> GetOverrides(MemberReference memberReference)
         {
             if (memberReference is MethodDefinition)
             {
diff --git a/mdoc/Mono.Documentation/Util/DataModel.cs b/mdoc/Mono.Documentation/Util/DataModel.cs
@@ -0,0 +1,10 @@
+﻿using System.Collections.Generic;
+using Mono.Cecil;
+namespace Mono.Documentation.Util
+{
+    public class Eiimembers
+    {
+        public string Fingerprint { get; set; }
+        public List<MemberReference> Interfaces { get; set; }
+    }
+}
diff --git a/mdoc/Test/en.expected.members-implementation/TestInterfaceImplementation/Class2_1.xml b/mdoc/Test/en.expected.members-implementation/TestInterfaceImplementation/Class2_1.xml
@@ -43,7 +43,6 @@
       <MemberType>Method</MemberType>
       <Implements>
         <InterfaceMember>M:TestInterfaceImplementation.Interface2.Method(System.Int32)</InterfaceMember>
-        <InterfaceMember>M:TestInterfaceImplementation.Interface3.Method(System.Int32)</InterfaceMember>
         <InterfaceMember>M:TestInterfaceImplementation.Interface3_1.Method(System.Int32)</InterfaceMember>
       </Implements>
       <AssemblyInfo>
diff --git a/mdoc/mdoc.Test/MDocUpdaterTests.cs b/mdoc/mdoc.Test/MDocUpdaterTests.cs
@@ -101,5 +101,62 @@ public void RemoveInvalidAssembliesInfo()
             //   foreach (var delitem in delList)
             // delitem.ParentNode.RemoveChild(child);        
         }
+
+        [Test]
+        public void UpdateToRight_MethodInterface_Test()
+        {
+            var member = GetType(typeof(mdoc.Test2.EiiImplementClass)).Methods.FirstOrDefault(t => t.FullName == "System.String mdoc.Test2.EiiImplementClass::GetNo()");
+            var nodeinfo = UpdateXml("GetNo", member);
+            Assert.IsTrue(nodeinfo.Count() == 1);
+            Assert.AreEqual("M:mdoc.Test2.Interface_B.GetNo", nodeinfo[0].InnerText);
+            Assert.AreEqual("dotnet-plat-ext-2.2", nodeinfo[0].GetAttribute(Consts.FrameworkAlternate));
+        }
+
+        [Test]
+        public void UpdateToRight_PropertyInterface_Test()
+        {
+            var member = GetType(typeof(mdoc.Test2.EiiImplementClass)).Properties.FirstOrDefault(t => t.FullName == "System.Int32 mdoc.Test2.EiiImplementClass::no()");
+            var nodeinfo = UpdateXml("no", member);
+            Assert.IsTrue(nodeinfo.Count() == 1);
+            Assert.AreEqual("P:mdoc.Test2.Interface_A.no", nodeinfo[0].InnerText);
+            Assert.AreEqual("dotnet-plat-ext-2.2", nodeinfo[0].GetAttribute(Consts.FrameworkAlternate));
+        }
+
+        [Test]
+        public void UpdateToRight_EventInterface_Test()
+        {
+            var member = GetType(typeof(mdoc.Test2.EiiImplementClass)).Events.FirstOrDefault(t => t.FullName == "System.EventHandler`1<System.EventArgs> mdoc.Test2.EiiImplementClass::ItemChanged");
+            var nodeinfo = UpdateXml("ItemChanged", member);
+            Assert.IsTrue(nodeinfo.Count() == 1);
+            Assert.AreEqual("E:mdoc.Test2.Interface_A.ItemChanged", nodeinfo[0].InnerText);
+            Assert.AreEqual("dotnet-plat-ext-2.2", nodeinfo[0].GetAttribute(Consts.FrameworkAlternate));
+        }
+
+        private List<XmlElement> UpdateXml(string XmlNodeName, MemberReference mi)
+        {
+            List<XmlElement> returnValue = new List<XmlElement>();
+
+            List<FrameworkEntry> entries = new List<FrameworkEntry>();
+            FrameworkEntry singleEntry = new FrameworkEntry(entries, entries);
+            singleEntry.Name = "dotnet-plat-ext-2.2";
+            FrameworkTypeEntry enttyType = new FrameworkTypeEntry(singleEntry);
+
+            var type = GetType(typeof(mdoc.Test2.EiiImplementClass));
+            var ieeImplementList = MDocUpdater.GetTypeEiiMembers(type);
+            var typeInterfaces = GetClassInterface(type);
+
+            var doc = new XmlDocument();
+            doc.LoadXml(XmlConsts.EiiErrorImplement);
+
+            var node = doc.SelectSingleNode($"/Type/Members/Member[@MemberName='{XmlNodeName}']");
+
+            if (node != null)
+            {
+                MDocUpdater.AddImplementedMembers(enttyType, mi, typeInterfaces, (XmlElement)node, ieeImplementList);
+                returnValue = node.SelectNodes("Implements/InterfaceMember").Cast<XmlElement>().ToList();
+            }
+
+            return returnValue;
+        }
     }
 }
diff --git a/mdoc/mdoc.Test/SampleClasses/EiiImplementclass.cs b/mdoc/mdoc.Test/SampleClasses/EiiImplementclass.cs
@@ -0,0 +1,35 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace mdoc.Test2
+{
+    public class EiiImplementClass : Interface_A,Interface_B
+    {
+        public event EventHandler<EventArgs> ItemChanged;
+        public string color { get; set; }
+
+        public int GetNum() => 3;
+
+        public int no { get; }
+        int Interface_B.no { get;  }
+
+        public string GetNo() => "1";
+        string Interface_A.GetNo() => "7";
+
+        public bool IsNum(string no) => false;
+        bool Interface_B.IsNum(string no) => true;
+
+        protected virtual void OnItemChanged(EventArgs e)
+        { }
+        
+        event EventHandler<EventArgs> Interface_B.ItemChanged
+        {
+            add { }
+            remove { }
+        }
+
+    }
+}
diff --git a/mdoc/mdoc.Test/SampleClasses/Interface_A.cs b/mdoc/mdoc.Test/SampleClasses/Interface_A.cs
@@ -0,0 +1,17 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace mdoc.Test2
+{
+    public interface Interface_A
+    {
+        string color { get; set; }
+        int  no  { get;  }
+        string GetNo();
+        int GetNum();
+        event EventHandler<EventArgs> ItemChanged;
+    }
+}
diff --git a/mdoc/mdoc.Test/SampleClasses/Interface_B.cs b/mdoc/mdoc.Test/SampleClasses/Interface_B.cs
@@ -0,0 +1,19 @@
+﻿using System;
+using System.Collections.Generic;
+using System.Linq;
+using System.Text;
+using System.Threading.Tasks;
+
+namespace mdoc.Test2
+{
+   public interface Interface_B
+   {
+        string color { get; set; }
+        int no { get;  }
+        string GetNo();
+        bool IsNum(string no);
+        event EventHandler<EventArgs> ItemChanged;
+
+
+    }
+}
diff --git a/mdoc/mdoc.Test/XmlConsts.cs b/mdoc/mdoc.Test/XmlConsts.cs
diff --git a/mdoc/mdoc.Test/mdoc.Test.csproj b/mdoc/mdoc.Test/mdoc.Test.csproj
diff --git a/mdoc/mdoc.csproj b/mdoc/mdoc.csproj

Original file line number	Diff line number	Diff line change
`@@ -796,7 +796,7 @@ public static bool IsExplicitlyImplemented(MemberReference memberReference)`
`796`	`796`	`/// <summary>`
`797`	`797`	`/// Get which members are overriden by memberReference`
`798`	`798`	`/// </summary>`
`799`		`- private static Collection<MethodReference> GetOverrides(MemberReference memberReference)`
	`799`	`+ public static Collection<MethodReference> GetOverrides(MemberReference memberReference)`
`800`	`800`	`{`
`801`	`801`	`if (memberReference is MethodDefinition)`
`802`	`802`	`{`