Merge pull request #5862 from MDoerner/StopBailingOutCompletelyOnFailedSupertypeResolution

retailcoder · web-flow · commit 0035fa391d5a · 2021-10-08T18:00:36.000-04:00
Stop bailing out completely on failed supertype resolution
diff --git a/Rubberduck.Parsing/Binding/Bindings/BindingContextBase.cs b/Rubberduck.Parsing/Binding/Bindings/BindingContextBase.cs
@@ -0,0 +1,36 @@
+﻿using Antlr4.Runtime;
+using Antlr4.Runtime.Tree;
+using NLog;
+using Rubberduck.Parsing.Symbols;
+
+namespace Rubberduck.Parsing.Binding
+{
+    public abstract class BindingContextBase : IBindingContext
+    {
+        private static readonly Logger Logger = LogManager.GetCurrentClassLogger();
+
+
+
+        protected IExpressionBinding HandleUnexpectedExpressionType(ParserRuleContext expression)
+        {
+            Logger.Warn($"Unexpected context type {expression.GetType()}");
+            return new FailedExpressionBinding(expression);
+        }
+
+        public abstract IBoundExpression Resolve(Declaration module,
+            Declaration parent,
+            ParserRuleContext expression,
+            IBoundExpression withBlockVariable,
+            StatementResolutionContext statementContext,
+            bool requiresLetCoercion = false,
+            bool isLetAssignment = false);
+
+        public abstract IExpressionBinding BuildTree(Declaration module,
+            Declaration parent,
+            ParserRuleContext expression,
+            IBoundExpression withBlockVariable,
+            StatementResolutionContext statementContext,
+            bool requiresLetCoercion = false,
+            bool isLetAssignment = false);
+    }
+}
diff --git a/Rubberduck.Parsing/Binding/Bindings/FailedExpressionBinding.cs b/Rubberduck.Parsing/Binding/Bindings/FailedExpressionBinding.cs
@@ -0,0 +1,19 @@
+﻿using Antlr4.Runtime;
+
+namespace Rubberduck.Parsing.Binding
+{
+    public sealed class FailedExpressionBinding : IExpressionBinding
+    {
+        private readonly ParserRuleContext _context;
+
+        public FailedExpressionBinding(ParserRuleContext context)
+        {
+            _context = context;
+        }
+
+        public IBoundExpression Resolve()
+        {
+            return new ResolutionFailedExpression(_context);
+        }
+    }
+}
diff --git a/Rubberduck.Parsing/Binding/DefaultBindingContext.cs b/Rubberduck.Parsing/Binding/DefaultBindingContext.cs
@@ -3,12 +3,11 @@
 using Rubberduck.Parsing.Symbols;
 using System;
 using System.Collections.Generic;
-using Antlr4.Runtime.Tree;
 using Rubberduck.Parsing.VBA.DeclarationCaching;
 
 namespace Rubberduck.Parsing.Binding
 {
-    public sealed class DefaultBindingContext : IBindingContext
+    public sealed class DefaultBindingContext : BindingContextBase
     {
         private readonly DeclarationFinder _declarationFinder;
         private readonly IBindingContext _typeBindingContext;
@@ -24,19 +23,24 @@ public DefaultBindingContext(
             _procedurePointerBindingContext = procedurePointerBindingContext;
         }
 
-        public IBoundExpression Resolve(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion, bool isLetAssignment)
+        public override IBoundExpression Resolve(Declaration module,
+            Declaration parent,
+            ParserRuleContext expression,
+            IBoundExpression withBlockVariable,
+            StatementResolutionContext statementContext,
+            bool requiresLetCoercion = false,
+            bool isLetAssignment = false)
         {
             var bindingTree = BuildTree(module, parent, expression, withBlockVariable, statementContext, requiresLetCoercion, isLetAssignment);
             return bindingTree?.Resolve();
         }
 
-        public IExpressionBinding BuildTree(
-            Declaration module, 
-            Declaration parent, 
-            IParseTree expression, 
-            IBoundExpression withBlockVariable, 
+        public override IExpressionBinding BuildTree(Declaration module,
+            Declaration parent,
+            ParserRuleContext expression,
+            IBoundExpression withBlockVariable,
             StatementResolutionContext statementContext,
-            bool requiresLetCoercion = false, 
+            bool requiresLetCoercion = false,
             bool isLetAssignment = false)
         {
             return Visit(
@@ -49,7 +53,7 @@ public IExpressionBinding BuildTree(
                 isLetAssignment);
         }
 
-        public IExpressionBinding Visit(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)
+        public IExpressionBinding Visit(Declaration module, Declaration parent, ParserRuleContext expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)
         {
             if (requiresLetCoercion && expression is ParserRuleContext context)
             {
@@ -76,7 +80,7 @@ public IExpressionBinding Visit(Declaration module, Declaration parent, IParseTr
                 case VBAParser.UnqualifiedObjectPrintStmtContext unqualifiedObjectPrintStmtContext:
                     return Visit(module, parent, unqualifiedObjectPrintStmtContext, withBlockVariable);
                 default:
-                    throw new NotSupportedException($"Unexpected context type {expression.GetType()}");
+                    return HandleUnexpectedExpressionType(expression);
             }
         }
 
@@ -160,7 +164,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars
                     return Visit(module, parent, builtInTypeExprContext, statementContext);
                 //We do not handle the VBAParser.TypeofexprContext because that should only ever appear as a child of an IS relational operator expression and is specifically handled there.
                 default:
-                    throw new NotSupportedException($"Unexpected expression type {expression.GetType()}");
+                    return HandleUnexpectedExpressionType(expression);
             }
         }
 
@@ -187,7 +191,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars
                 case VBAParser.ObjectPrintExprContext objectPrintExprContext:
                     return Visit(module, parent, objectPrintExprContext, withBlockVariable);
                 default:
-                    throw new NotSupportedException($"Unexpected lExpression type {expression.GetType()}");
+                    return HandleUnexpectedExpressionType(expression);
             }
         }
 
diff --git a/Rubberduck.Parsing/Binding/IBindingContext.cs b/Rubberduck.Parsing/Binding/IBindingContext.cs
@@ -1,11 +1,25 @@
-﻿using Antlr4.Runtime.Tree;
+﻿using Antlr4.Runtime;
 using Rubberduck.Parsing.Symbols;
 
 namespace Rubberduck.Parsing.Binding
 {
     public interface IBindingContext
     {
-        IBoundExpression Resolve(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false);
-        IExpressionBinding BuildTree(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false);
+        IBoundExpression Resolve(
+            Declaration module, 
+            Declaration parent, 
+            ParserRuleContext expression,
+            IBoundExpression withBlockVariable, 
+            StatementResolutionContext statementContext,
+            bool requiresLetCoercion = false, 
+            bool isLetAssignment = false);
+        IExpressionBinding BuildTree(
+            Declaration module, 
+            Declaration parent, 
+            ParserRuleContext expression,
+            IBoundExpression withBlockVariable, 
+            StatementResolutionContext statementContext,
+            bool requiresLetCoercion = false, 
+            bool isLetAssignment = false);
     }
 }
diff --git a/Rubberduck.Parsing/Binding/ProcedurePointerBindingContext.cs b/Rubberduck.Parsing/Binding/ProcedurePointerBindingContext.cs
@@ -1,12 +1,11 @@
-﻿using System;
-using Antlr4.Runtime.Tree;
+﻿using Antlr4.Runtime;
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA.DeclarationCaching;
 
 namespace Rubberduck.Parsing.Binding
 {
-    public sealed class ProcedurePointerBindingContext : IBindingContext
+    public sealed class ProcedurePointerBindingContext : BindingContextBase
     {
         private readonly DeclarationFinder _declarationFinder;
 
@@ -15,7 +14,14 @@ public ProcedurePointerBindingContext(DeclarationFinder declarationFinder)
             _declarationFinder = declarationFinder;
         }
 
-        public IBoundExpression Resolve(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)
+        public override IBoundExpression Resolve(
+            Declaration module, 
+            Declaration parent, 
+            ParserRuleContext expression,
+            IBoundExpression withBlockVariable, 
+            StatementResolutionContext statementContext,
+            bool requiresLetCoercion = false, 
+            bool isLetAssignment = false)
         {
             IExpressionBinding bindingTree = BuildTree(module, parent, expression, withBlockVariable, statementContext);
             if (bindingTree != null)
@@ -25,7 +31,14 @@ public IBoundExpression Resolve(Declaration module, Declaration parent, IParseTr
             return null;
         }
 
-        public IExpressionBinding BuildTree(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)
+        public override IExpressionBinding BuildTree(
+            Declaration module, 
+            Declaration parent,
+            ParserRuleContext expression, 
+            IBoundExpression withBlockVariable,
+            StatementResolutionContext statementContext, 
+            bool requiresLetCoercion = false, 
+            bool isLetAssignment = false)
         {
             switch (expression)
             {
@@ -36,7 +49,7 @@ public IExpressionBinding BuildTree(Declaration module, Declaration parent, IPar
                 case VBAParser.AddressOfExpressionContext addressOfExpressionContext:
                     return Visit(module, parent, addressOfExpressionContext);
                 default:
-                    throw new NotSupportedException($"Unexpected context type {expression.GetType()}");
+                    return HandleUnexpectedExpressionType(expression);
             }
         }
 
@@ -52,7 +65,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars
                 case VBAParser.LExprContext lExprContext:
                     return Visit(module, parent, lExprContext.lExpression());
                 default:
-                    throw new NotSupportedException($"Unexpected expression type {expression.GetType()}");
+                    return HandleUnexpectedExpressionType(expression);
             }
         }
 
@@ -65,7 +78,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars
                 case VBAParser.MemberAccessExprContext memberAccessExprContext:
                     return Visit(module, parent, memberAccessExprContext);
                 default:
-                    throw new NotSupportedException($"Unexpected lExpression type {expression.GetType()}");
+                    return HandleUnexpectedExpressionType(expression);
             }
         }
 
diff --git a/Rubberduck.Parsing/Binding/TypeBindingContext.cs b/Rubberduck.Parsing/Binding/TypeBindingContext.cs
@@ -1,12 +1,11 @@
-﻿using System;
-using Antlr4.Runtime.Tree;
+﻿using Antlr4.Runtime;
 using Rubberduck.Parsing.Grammar;
 using Rubberduck.Parsing.Symbols;
 using Rubberduck.Parsing.VBA.DeclarationCaching;
 
 namespace Rubberduck.Parsing.Binding
 {
-    public sealed class TypeBindingContext : IBindingContext
+    public sealed class TypeBindingContext : BindingContextBase
     {
         private readonly DeclarationFinder _declarationFinder;
 
@@ -15,13 +14,26 @@ public TypeBindingContext(DeclarationFinder declarationFinder)
             _declarationFinder = declarationFinder;
         }
 
-        public IBoundExpression Resolve(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)
+        public override IBoundExpression Resolve(
+            Declaration module, 
+            Declaration parent, ParserRuleContext expression,
+            IBoundExpression withBlockVariable, 
+            StatementResolutionContext statementContext,
+            bool requiresLetCoercion = false, 
+            bool isLetAssignment = false)
         {
             IExpressionBinding bindingTree = BuildTree(module, parent, expression, withBlockVariable, statementContext);
             return bindingTree?.Resolve();
         }
 
-        public IExpressionBinding BuildTree(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)
+        public override IExpressionBinding BuildTree(
+            Declaration module, 
+            Declaration parent,
+            ParserRuleContext expression, 
+            IBoundExpression withBlockVariable,
+            StatementResolutionContext statementContext, 
+            bool requiresLetCoercion = false, 
+            bool isLetAssignment = false)
         {
             switch (expression)
             {
@@ -32,7 +44,7 @@ public IExpressionBinding BuildTree(Declaration module, Declaration parent, IPar
                 case VBAParser.BuiltInTypeExprContext builtInTypeExprContext:
                     return Visit(builtInTypeExprContext.builtInType());
                 default:
-                    throw new NotSupportedException($"Unexpected context type {expression.GetType()}");
+                    return HandleUnexpectedExpressionType(expression);
             }
         }
 
@@ -52,7 +64,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars
                 case VBAParser.IndexExprContext indexExprContext:
                     return Visit(module, parent, indexExprContext);
                 default:
-                    throw new NotSupportedException($"Unexpected lExpression type {expression.GetType()}");
+                    return HandleUnexpectedExpressionType(expression);
             }
         }
 

Original file line number	Diff line number	Diff line change
`@@ -3,12 +3,11 @@`
`3`	`3`	`using Rubberduck.Parsing.Symbols;`
`4`	`4`	`using System;`
`5`	`5`	`using System.Collections.Generic;`
`6`		`-using Antlr4.Runtime.Tree;`
`7`	`6`	`using Rubberduck.Parsing.VBA.DeclarationCaching;`
`8`	`7`
`9`	`8`	`namespace Rubberduck.Parsing.Binding`
`10`	`9`	`{`
`11`		`- public sealed class DefaultBindingContext : IBindingContext`
	`10`	`+ public sealed class DefaultBindingContext : BindingContextBase`
`12`	`11`	`{`
`13`	`12`	`private readonly DeclarationFinder _declarationFinder;`
`14`	`13`	`private readonly IBindingContext _typeBindingContext;`
`@@ -24,19 +23,24 @@ public DefaultBindingContext(`
`24`	`23`	`_procedurePointerBindingContext = procedurePointerBindingContext;`
`25`	`24`	`}`
`26`	`25`
`27`		`- public IBoundExpression Resolve(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion, bool isLetAssignment)`
	`26`	`+ public override IBoundExpression Resolve(Declaration module,`
	`27`	`+ Declaration parent,`
	`28`	`+ ParserRuleContext expression,`
	`29`	`+ IBoundExpression withBlockVariable,`
	`30`	`+ StatementResolutionContext statementContext,`
	`31`	`+ bool requiresLetCoercion = false,`
	`32`	`+ bool isLetAssignment = false)`
`28`	`33`	`{`
`29`	`34`	`var bindingTree = BuildTree(module, parent, expression, withBlockVariable, statementContext, requiresLetCoercion, isLetAssignment);`
`30`	`35`	`return bindingTree?.Resolve();`
`31`	`36`	`}`
`32`	`37`
`33`		`- public IExpressionBinding BuildTree(`
`34`		`- Declaration module,`
`35`		`- Declaration parent,`
`36`		`- IParseTree expression,`
`37`		`- IBoundExpression withBlockVariable,`
	`38`	`+ public override IExpressionBinding BuildTree(Declaration module,`
	`39`	`+ Declaration parent,`
	`40`	`+ ParserRuleContext expression,`
	`41`	`+ IBoundExpression withBlockVariable,`
`38`	`42`	`StatementResolutionContext statementContext,`
`39`		`- bool requiresLetCoercion = false,`
	`43`	`+ bool requiresLetCoercion = false,`
`40`	`44`	`bool isLetAssignment = false)`
`41`	`45`	`{`
`42`	`46`	`return Visit(`
`@@ -49,7 +53,7 @@ public IExpressionBinding BuildTree(`
`49`	`53`	`isLetAssignment);`
`50`	`54`	`}`
`51`	`55`
`52`		`- public IExpressionBinding Visit(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)`
	`56`	`+ public IExpressionBinding Visit(Declaration module, Declaration parent, ParserRuleContext expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)`
`53`	`57`	`{`
`54`	`58`	`if (requiresLetCoercion && expression is ParserRuleContext context)`
`55`	`59`	`{`
`@@ -76,7 +80,7 @@ public IExpressionBinding Visit(Declaration module, Declaration parent, IParseTr`
`76`	`80`	`case VBAParser.UnqualifiedObjectPrintStmtContext unqualifiedObjectPrintStmtContext:`
`77`	`81`	`return Visit(module, parent, unqualifiedObjectPrintStmtContext, withBlockVariable);`
`78`	`82`	`default:`
`79`		`- throw new NotSupportedException($"Unexpected context type {expression.GetType()}");`
	`83`	`+ return HandleUnexpectedExpressionType(expression);`
`80`	`84`	`}`
`81`	`85`	`}`
`82`	`86`
`@@ -160,7 +164,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars`
`160`	`164`	`return Visit(module, parent, builtInTypeExprContext, statementContext);`
`161`	`165`	`//We do not handle the VBAParser.TypeofexprContext because that should only ever appear as a child of an IS relational operator expression and is specifically handled there.`
`162`	`166`	`default:`
`163`		`- throw new NotSupportedException($"Unexpected expression type {expression.GetType()}");`
	`167`	`+ return HandleUnexpectedExpressionType(expression);`
`164`	`168`	`}`
`165`	`169`	`}`
`166`	`170`
`@@ -187,7 +191,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars`
`187`	`191`	`case VBAParser.ObjectPrintExprContext objectPrintExprContext:`
`188`	`192`	`return Visit(module, parent, objectPrintExprContext, withBlockVariable);`
`189`	`193`	`default:`
`190`		`- throw new NotSupportedException($"Unexpected lExpression type {expression.GetType()}");`
	`194`	`+ return HandleUnexpectedExpressionType(expression);`
`191`	`195`	`}`
`192`	`196`	`}`
`193`	`197`
Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,11 @@`
`1`		`-using System;`
`2`		`-using Antlr4.Runtime.Tree;`
	`1`	`+using Antlr4.Runtime;`
`3`	`2`	`using Rubberduck.Parsing.Grammar;`
`4`	`3`	`using Rubberduck.Parsing.Symbols;`
`5`	`4`	`using Rubberduck.Parsing.VBA.DeclarationCaching;`
`6`	`5`
`7`	`6`	`namespace Rubberduck.Parsing.Binding`
`8`	`7`	`{`
`9`		`- public sealed class ProcedurePointerBindingContext : IBindingContext`
	`8`	`+ public sealed class ProcedurePointerBindingContext : BindingContextBase`
`10`	`9`	`{`
`11`	`10`	`private readonly DeclarationFinder _declarationFinder;`
`12`	`11`
`@@ -15,7 +14,14 @@ public ProcedurePointerBindingContext(DeclarationFinder declarationFinder)`
`15`	`14`	`_declarationFinder = declarationFinder;`
`16`	`15`	`}`
`17`	`16`
`18`		`- public IBoundExpression Resolve(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)`
	`17`	`+ public override IBoundExpression Resolve(`
	`18`	`+ Declaration module,`
	`19`	`+ Declaration parent,`
	`20`	`+ ParserRuleContext expression,`
	`21`	`+ IBoundExpression withBlockVariable,`
	`22`	`+ StatementResolutionContext statementContext,`
	`23`	`+ bool requiresLetCoercion = false,`
	`24`	`+ bool isLetAssignment = false)`
`19`	`25`	`{`
`20`	`26`	`IExpressionBinding bindingTree = BuildTree(module, parent, expression, withBlockVariable, statementContext);`
`21`	`27`	`if (bindingTree != null)`
`@@ -25,7 +31,14 @@ public IBoundExpression Resolve(Declaration module, Declaration parent, IParseTr`
`25`	`31`	`return null;`
`26`	`32`	`}`
`27`	`33`
`28`		`- public IExpressionBinding BuildTree(Declaration module, Declaration parent, IParseTree expression, IBoundExpression withBlockVariable, StatementResolutionContext statementContext, bool requiresLetCoercion = false, bool isLetAssignment = false)`
	`34`	`+ public override IExpressionBinding BuildTree(`
	`35`	`+ Declaration module,`
	`36`	`+ Declaration parent,`
	`37`	`+ ParserRuleContext expression,`
	`38`	`+ IBoundExpression withBlockVariable,`
	`39`	`+ StatementResolutionContext statementContext,`
	`40`	`+ bool requiresLetCoercion = false,`
	`41`	`+ bool isLetAssignment = false)`
`29`	`42`	`{`
`30`	`43`	`switch (expression)`
`31`	`44`	`{`
`@@ -36,7 +49,7 @@ public IExpressionBinding BuildTree(Declaration module, Declaration parent, IPar`
`36`	`49`	`case VBAParser.AddressOfExpressionContext addressOfExpressionContext:`
`37`	`50`	`return Visit(module, parent, addressOfExpressionContext);`
`38`	`51`	`default:`
`39`		`- throw new NotSupportedException($"Unexpected context type {expression.GetType()}");`
	`52`	`+ return HandleUnexpectedExpressionType(expression);`
`40`	`53`	`}`
`41`	`54`	`}`
`42`	`55`
`@@ -52,7 +65,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars`
`52`	`65`	`case VBAParser.LExprContext lExprContext:`
`53`	`66`	`return Visit(module, parent, lExprContext.lExpression());`
`54`	`67`	`default:`
`55`		`- throw new NotSupportedException($"Unexpected expression type {expression.GetType()}");`
	`68`	`+ return HandleUnexpectedExpressionType(expression);`
`56`	`69`	`}`
`57`	`70`	`}`
`58`	`71`
`@@ -65,7 +78,7 @@ private IExpressionBinding Visit(Declaration module, Declaration parent, VBAPars`
`65`	`78`	`case VBAParser.MemberAccessExprContext memberAccessExprContext:`
`66`	`79`	`return Visit(module, parent, memberAccessExprContext);`
`67`	`80`	`default:`
`68`		`- throw new NotSupportedException($"Unexpected lExpression type {expression.GetType()}");`
	`81`	`+ return HandleUnexpectedExpressionType(expression);`
`69`	`82`	`}`
`70`	`83`	`}`
`71`	`84`