Add Doc for inherited methods in methodmaps

Hexer10 · Hexer10 · commit 6dbf7b4acdf0 · 2022-03-22T16:40:00.000+01:00
diff --git a/SourcepawnCondenser/SourcepawnCondenser/CondenserFunctions/SMClasslike.cs b/SourcepawnCondenser/SourcepawnCondenser/CondenserFunctions/SMClasslike.cs
@@ -14,7 +14,7 @@ public abstract class SMClasslike : SMBaseDefinition
     public readonly List<SMObjectField> Fields = new();
     public readonly List<SMObjectMethod> Methods = new();
     
-    public List<ACNode> ProduceNodes()
+    public virtual List<ACNode> ProduceNodes(SMDefinition smDef)
     {
         var nodes = new List<ACNode>();
         nodes.AddRange(ACNode.ConvertFromStringList(Methods.Select(e => e.Name), true, "▲ "));
@@ -26,15 +26,15 @@ public List<ACNode> ProduceNodes()
     }
 }
 
-public abstract class SMObjectMethod : SMBaseDefinition
+public class SMObjectMethod : SMBaseDefinition
 {
     public string ClassName = string.Empty;
     public string FullName = string.Empty;
     public string ReturnType = string.Empty;
     public string[] Parameters = Array.Empty<string>();
 }
 
-public abstract class SMObjectField : SMBaseDefinition
+public class SMObjectField : SMBaseDefinition
 {
     public string ClassName = string.Empty;
     public string FullName = string.Empty;
diff --git a/SourcepawnCondenser/SourcepawnCondenser/CondenserFunctions/SMEnumStructConsumer.cs b/SourcepawnCondenser/SourcepawnCondenser/CondenserFunctions/SMEnumStructConsumer.cs
@@ -15,8 +15,8 @@ private int ConsumeSMEnumStruct()
             if (position + 4 < length)
             {
                 var enumStructName = string.Empty;
-                var methods = new List<SMEnumStructMethod>();
-                var fields = new List<SMEnumStructField>();
+                var methods = new List<SMObjectMethod>();
+                var fields = new List<SMObjectField>();
                 if (t[iteratePosition].Kind == TokenKind.Identifier)
                 {
                     enumStructName = t[iteratePosition++].Value;
@@ -198,7 +198,7 @@ private int ConsumeSMEnumStruct()
 
                             if (mStartIndex < mEndIndex)
                             {
-                                methods.Add(new SMEnumStructMethod
+                                methods.Add(new SMObjectMethod
                                 {
                                     Index = mStartIndex,
                                     Name = methodName,
@@ -286,13 +286,13 @@ private int ConsumeSMEnumStruct()
 
                             if (fStartIndex < fEndIndex)
                             {
-                                fields.Add(new SMEnumStructField
+                                fields.Add(new SMObjectField()
                                 {
                                     Index = fStartIndex,
                                     Length = fEndIndex - fStartIndex + 1,
                                     Name = fieldName,
                                     File = FileName,
-                                    MethodmapName = enumStructName,
+                                    // MethodmapName = enumStructName,
                                     FullName = source.Substring(fStartIndex, fEndIndex - fStartIndex + 1)
                                 });
                             }
diff --git a/SourcepawnCondenser/SourcepawnCondenser/CondenserFunctions/SMMethodmapConsumer.cs b/SourcepawnCondenser/SourcepawnCondenser/CondenserFunctions/SMMethodmapConsumer.cs
@@ -15,8 +15,8 @@ private int ConsumeSMMethodmap()
             if ((position + 4) < length)
             {
                 var methodMapName = string.Empty;
-                var methods = new List<SMMethodmapMethod>();
-                var fields = new List<SMMethodmapField>();
+                var methods = new List<SMObjectMethod>();
+                var fields = new List<SMObjectField>();
                 if (t[iteratePosition].Kind == TokenKind.Identifier)
                 {
                     methodMapName = t[iteratePosition].Value;
@@ -202,7 +202,7 @@ private int ConsumeSMMethodmap()
                             }
                             if (mStartIndex < mEndIndex)
                             {
-                                methods.Add(new SMMethodmapMethod()
+                                methods.Add(new SMObjectMethod()
                                 {
                                     Index = mStartIndex,
                                     Name = methodName,
@@ -283,7 +283,7 @@ private int ConsumeSMMethodmap()
                             }
                             if (fStartIndex < fEndIndex)
                             {
-                                fields.Add(new SMMethodmapField
+                                fields.Add(new SMObjectField
                                 {
                                     Index = fStartIndex,
                                     Length = fEndIndex - fStartIndex + 1,
diff --git a/SourcepawnCondenser/SourcepawnCondenser/SourcemodDefinition/SMDefinition.cs b/SourcepawnCondenser/SourcepawnCondenser/SourcemodDefinition/SMDefinition.cs
@@ -17,7 +17,7 @@ public SMDefinition()
                     Name = "Handle",
                     Methods =
                     {
-                        new SMMethodmapMethod()
+                        new SMObjectMethod()
                         {
                             FullName = "(external) void Close()",
                             ClassName = "Name",
diff --git a/SourcepawnCondenser/SourcepawnCondenser/SourcemodDefinition/SMEnumStruct.cs b/SourcepawnCondenser/SourcepawnCondenser/SourcemodDefinition/SMEnumStruct.cs
@@ -6,14 +6,4 @@ namespace SourcepawnCondenser.SourcemodDefinition
     public class SMEnumStruct : SMClasslike
     {
     }
-
-    public class SMEnumStructField : SMObjectField
-    {
-        public string MethodmapName = string.Empty;
-        //public string Type = string.Empty; not needed yet
-    }
-
-    public class SMEnumStructMethod : SMObjectMethod
-    {
-    }
 }
diff --git a/SourcepawnCondenser/SourcepawnCondenser/SourcemodDefinition/SMMethodmap.cs b/SourcepawnCondenser/SourcepawnCondenser/SourcemodDefinition/SMMethodmap.cs
@@ -6,13 +6,33 @@ namespace SourcepawnCondenser.SourcemodDefinition
     public class SMMethodmap : SMClasslike
     {
         public string InheritedType = string.Empty;
-    }
 
-    public class SMMethodmapField : SMObjectField
-    {
-    }
+        public override List<ACNode> ProduceNodes(SMDefinition smDef)
+        {
+            var nodes = new List<ACNode>();
+            nodes.AddRange(ACNode.ConvertFromStringList(Methods.Select(e => e.Name), true, "▲ "));
+            nodes.AddRange(ACNode.ConvertFromStringList(Fields.Select(e => e.Name), false, "• "));
 
-    public class SMMethodmapMethod : SMObjectMethod
-    {
+            // Find Fields and Methods inherited from the "super-class".
+            var inheritedType = InheritedType;
+            for (;;)
+            {
+                if (inheritedType.Length == 0)
+                    break;
+
+                var mm = smDef.Methodmaps.Find(e => e.Name == InheritedType);
+                if (mm == null)
+                    break;
+
+                nodes.AddRange(ACNode.ConvertFromStringList(mm.Methods.Select(e => e.Name), true, "▲ "));
+                nodes.AddRange(ACNode.ConvertFromStringList(mm.Fields.Select(e => e.Name), false, "• "));
+
+                inheritedType = mm.InheritedType;
+            }
+
+            nodes.Sort((a, b) => string.CompareOrdinal(a.EntryName, b.EntryName));
+
+            return nodes;
+        }
     }
 }
diff --git a/UI/Components/EditorElement/EditorElementIntellisenseController.cs b/UI/Components/EditorElement/EditorElementIntellisenseController.cs
@@ -292,9 +292,20 @@ bool ComputeIntelliSense(string text, int lineOffset)
 
                         if (classString.Length > 0)
                         {
-                            var methodMap = FindClass(classString);
+                            var classObj = FindClass(classString);
+
+                            SMObjectMethod? method = null;
+
+                            switch (classObj)
+                            {
+                                case SMEnumStruct:
+                                    method = classObj?.Methods.Find(e => e.Name == methodString);
+                                    break;
+                                case SMMethodmap obj:
+                                    method = FindMethod(methodString, obj, _smDef);
+                                    break;
+                            }
 
-                            var method = methodMap?.Methods.FirstOrDefault(e => e.Name == methodString);
 
                             if (method == null)
                                 continue;
@@ -355,6 +366,24 @@ bool ComputeIntelliSense(string text, int lineOffset)
                    _smDef.EnumStructs.FirstOrDefault(e => e.Name == varDecl.Type);
         }
 
+        SMObjectMethod? FindMethod(string methodName, SMMethodmap methodMap, SMDefinition smDef)
+        {
+            var mm = methodMap;
+            while (mm != null)
+            {
+                var method = mm.Methods.Find(e => e.Name == methodName);
+                if (method != null)
+                    return method;
+
+                if (mm.InheritedType.Length == 0)
+                    return null;
+
+                mm = smDef.Methodmaps.Find(e => e.Name == mm.InheritedType);
+            }
+
+            return null;
+        }
+
         /// <summary>
         /// Triggers the AutoComplete tooltip to be shown if a suggestion is found.
         /// </summary>
@@ -494,7 +523,7 @@ bool ComputeAutoComplete(string text, int lineOffset, int quoteCount)
                     return false;
                 }
 
-                var isNodes = mm.ProduceNodes();
+                var isNodes = mm.ProduceNodes(_smDef);
 
                 if (!isNodes.SequenceEqual(_methodACEntries, ISEqualityComparer))
                 {
diff --git a/UI/Windows/SPDefinitionWindow.xaml.cs b/UI/Windows/SPDefinitionWindow.xaml.cs
@@ -9,6 +9,7 @@
 using System.Windows.Media;
 using MahApps.Metro;
 using MahApps.Metro.Controls;
+using SourcepawnCondenser;
 using SourcepawnCondenser.SourcemodDefinition;
 using static SPCode.Interop.TranslationProvider;
 
@@ -191,7 +192,7 @@ private void SPFunctionsListBox_SelectionChanged(object sender, SelectionChanged
                     return;
                 }
 
-                if (TagValue is SMMethodmapMethod method)
+                if (TagValue is SMObjectMethod method)
                 {
                     SPNameBlock.Text = method.Name;
                     SPFullNameBlock.Text = method.FullName;
@@ -202,7 +203,7 @@ private void SPFunctionsListBox_SelectionChanged(object sender, SelectionChanged
                     return;
                 }
 
-                if (TagValue is SMMethodmapField field)
+                if (TagValue is SMObjectField field)
                 {
                     SPNameBlock.Text = field.Name;
                     SPFullNameBlock.Text = field.FullName;

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ public abstract class SMClasslike : SMBaseDefinition`
`14`	`14`	`public readonly List<SMObjectField> Fields = new();`
`15`	`15`	`public readonly List<SMObjectMethod> Methods = new();`
`16`	`16`
`17`		`- public List<ACNode> ProduceNodes()`
	`17`	`+ public virtual List<ACNode> ProduceNodes(SMDefinition smDef)`
`18`	`18`	`{`
`19`	`19`	`var nodes = new List<ACNode>();`
`20`	`20`	`nodes.AddRange(ACNode.ConvertFromStringList(Methods.Select(e => e.Name), true, "▲ "));`
`@@ -26,15 +26,15 @@ public List<ACNode> ProduceNodes()`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`
`29`		`-public abstract class SMObjectMethod : SMBaseDefinition`
	`29`	`+public class SMObjectMethod : SMBaseDefinition`
`30`	`30`	`{`
`31`	`31`	`public string ClassName = string.Empty;`
`32`	`32`	`public string FullName = string.Empty;`
`33`	`33`	`public string ReturnType = string.Empty;`
`34`	`34`	`public string[] Parameters = Array.Empty<string>();`
`35`	`35`	`}`
`36`	`36`
`37`		`-public abstract class SMObjectField : SMBaseDefinition`
	`37`	`+public class SMObjectField : SMBaseDefinition`
`38`	`38`	`{`
`39`	`39`	`public string ClassName = string.Empty;`
`40`	`40`	`public string FullName = string.Empty;`
Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@ private int ConsumeSMEnumStruct()`
`15`	`15`	`if (position + 4 < length)`
`16`	`16`	`{`
`17`	`17`	`var enumStructName = string.Empty;`
`18`		`- var methods = new List<SMEnumStructMethod>();`
`19`		`- var fields = new List<SMEnumStructField>();`
	`18`	`+ var methods = new List<SMObjectMethod>();`
	`19`	`+ var fields = new List<SMObjectField>();`
`20`	`20`	`if (t[iteratePosition].Kind == TokenKind.Identifier)`
`21`	`21`	`{`
`22`	`22`	`enumStructName = t[iteratePosition++].Value;`
`@@ -198,7 +198,7 @@ private int ConsumeSMEnumStruct()`
`198`	`198`
`199`	`199`	`if (mStartIndex < mEndIndex)`
`200`	`200`	`{`
`201`		`- methods.Add(new SMEnumStructMethod`
	`201`	`+ methods.Add(new SMObjectMethod`
`202`	`202`	`{`
`203`	`203`	`Index = mStartIndex,`
`204`	`204`	`Name = methodName,`
`@@ -286,13 +286,13 @@ private int ConsumeSMEnumStruct()`
`286`	`286`
`287`	`287`	`if (fStartIndex < fEndIndex)`
`288`	`288`	`{`
`289`		`- fields.Add(new SMEnumStructField`
	`289`	`+ fields.Add(new SMObjectField()`
`290`	`290`	`{`
`291`	`291`	`Index = fStartIndex,`
`292`	`292`	`Length = fEndIndex - fStartIndex + 1,`
`293`	`293`	`Name = fieldName,`
`294`	`294`	`File = FileName,`
`295`		`- MethodmapName = enumStructName,`
	`295`	`+ // MethodmapName = enumStructName,`
`296`	`296`	`FullName = source.Substring(fStartIndex, fEndIndex - fStartIndex + 1)`
`297`	`297`	`});`
`298`	`298`	`}`
Original file line number	Diff line number	Diff line change
`@@ -17,7 +17,7 @@ public SMDefinition()`
`17`	`17`	`Name = "Handle",`
`18`	`18`	`Methods =`
`19`	`19`	`{`
`20`		`- new SMMethodmapMethod()`
	`20`	`+ new SMObjectMethod()`
`21`	`21`	`{`
`22`	`22`	`FullName = "(external) void Close()",`
`23`	`23`	`ClassName = "Name",`
Original file line number	Diff line number	Diff line change
`@@ -6,14 +6,4 @@ namespace SourcepawnCondenser.SourcemodDefinition`
`6`	`6`	`public class SMEnumStruct : SMClasslike`
`7`	`7`	`{`
`8`	`8`	`}`
`9`		`-`
`10`		`- public class SMEnumStructField : SMObjectField`
`11`		`- {`
`12`		`- public string MethodmapName = string.Empty;`
`13`		`- //public string Type = string.Empty; not needed yet`
`14`		`- }`
`15`		`-`
`16`		`- public class SMEnumStructMethod : SMObjectMethod`
`17`		`- {`
`18`		`- }`
`19`	`9`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,6 +9,7 @@`
`9`	`9`	`using System.Windows.Media;`
`10`	`10`	`using MahApps.Metro;`
`11`	`11`	`using MahApps.Metro.Controls;`
	`12`	`+using SourcepawnCondenser;`
`12`	`13`	`using SourcepawnCondenser.SourcemodDefinition;`
`13`	`14`	`using static SPCode.Interop.TranslationProvider;`
`14`	`15`
`@@ -191,7 +192,7 @@ private void SPFunctionsListBox_SelectionChanged(object sender, SelectionChanged`
`191`	`192`	`return;`
`192`	`193`	`}`
`193`	`194`
`194`		`- if (TagValue is SMMethodmapMethod method)`
	`195`	`+ if (TagValue is SMObjectMethod method)`
`195`	`196`	`{`
`196`	`197`	`SPNameBlock.Text = method.Name;`
`197`	`198`	`SPFullNameBlock.Text = method.FullName;`
`@@ -202,7 +203,7 @@ private void SPFunctionsListBox_SelectionChanged(object sender, SelectionChanged`
`202`	`203`	`return;`
`203`	`204`	`}`
`204`	`205`
`205`		`- if (TagValue is SMMethodmapField field)`
	`206`	`+ if (TagValue is SMObjectField field)`
`206`	`207`	`{`
`207`	`208`	`SPNameBlock.Text = field.Name;`
`208`	`209`	`SPFullNameBlock.Text = field.FullName;`