Merge pull request #5721 from retailcoder/resolve-supertypes

Fixes the resolution of default instance variables

Author: retailcoder

Rubberduck.CodeAnalysis/Inspections/Abstract/ImplicitSheetReferenceInspectionBase.cs

@@ -26,6 +26,7 @@ protected override IEnumerable<Declaration> ObjectionableDeclarations(Declaratio
                 .Select(className => finder.FindClassModule(className, excel, true))
                 .OfType<ModuleDeclaration>();
 
+
             return globalModules
                 .SelectMany(moduleClass => moduleClass.Members)
                 .Where(declaration => TargetMemberNames.Contains(declaration.IdentifierName)
@@ -35,7 +36,8 @@ protected override IEnumerable<Declaration> ObjectionableDeclarations(Declaratio
 
         private static readonly string[] GlobalObjectClassNames =
         {
-            "Global", "_Global"
+            "Global", "_Global", 
+            "Worksheet", "_Worksheet"
         };
 
         private static readonly string[] TargetMemberNames =

Rubberduck.CodeAnalysis/Inspections/Abstract/ImplicitWorkbookReferenceInspectionBase.cs

@@ -24,9 +24,7 @@ internal ImplicitWorkbookReferenceInspectionBase(IDeclarationFinderProvider decl
 
         protected override IEnumerable<Declaration> ObjectionableDeclarations(DeclarationFinder finder)
         {
-            var excel = finder.Projects
-                .SingleOrDefault(project => project.IdentifierName == "Excel" && !project.IsUserDefined);
-            if (excel == null)
+            if (!finder.TryFindProjectDeclaration("Excel", out var excel))
             {
                 return Enumerable.Empty<Declaration>();
             }

Rubberduck.CodeAnalysis/Inspections/Concrete/AssignmentNotUsedInspection.cs

@@ -131,20 +131,19 @@ private static IEnumerable<AssignmentNode> FindUnusedAssignmentNodes(INode node,
                                                             .Contains(refNode));
 
                 var assignmentsPrecedingReference = assignmentExprNodesWithReference.Any()
-                    ? assignmentExprNodes.TakeWhile(n => n != assignmentExprNodesWithReference.Last())
-                                                .Last()
-                                                .Nodes(new[] { typeof(AssignmentNode) })
+                    ? assignmentExprNodes.TakeWhile(n => n != assignmentExprNodesWithReference.LastOrDefault())
+                                                ?.LastOrDefault()
+                                                ?.Nodes(new[] { typeof(AssignmentNode) })
                     : allAssignmentsAndReferences.TakeWhile(n => n != refNode)
                         .OfType<AssignmentNode>();
 
-                if (assignmentsPrecedingReference.Any())
+                if (assignmentsPrecedingReference?.Any() ?? false)
                 {
-                    usedAssignments.Add(assignmentsPrecedingReference.Last() as AssignmentNode);
+                    usedAssignments.Add(assignmentsPrecedingReference.LastOrDefault() as AssignmentNode);
                 }
             }
 
-            return allAssignmentsAndReferences.OfType<AssignmentNode>()
-                                                .Except(usedAssignments);
+            return allAssignmentsAndReferences.OfType<AssignmentNode>().Except(usedAssignments);
         }
 
         private static bool IsDescendentOfNeverFlagNode(AssignmentNode assignment)

Rubberduck.CodeAnalysis/Inspections/Concrete/SheetAccessedUsingStringInspection.cs

@@ -61,19 +61,19 @@ public SheetAccessedUsingStringInspection(IDeclarationFinderProvider declaration
 
         private static readonly string[] InterestingMembers =
         {
-            "Worksheets", "Sheets"
+            "Worksheets", // gets a Sheets object containing Worksheet objects.
+            "Sheets", // gets a Sheets object containing all sheets (not just Worksheet sheets) in the qualifying workbook.
         };
 
         private static readonly string[] InterestingClasses =
         {
-            "Workbook"
+            "Workbook", // unqualified member call
+            "_Workbook", // qualified member call
         };
 
         protected override IEnumerable<Declaration> ObjectionableDeclarations(DeclarationFinder finder)
         {
-            var excel = finder.Projects
-                .SingleOrDefault(project => project.IdentifierName == "Excel" && !project.IsUserDefined);
-            if (excel == null)
+            if (!finder.TryFindProjectDeclaration("Excel", out var excel))
             {
                 return Enumerable.Empty<Declaration>();
             }

Rubberduck.Parsing/Binding/Bindings/SimpleNameDefaultBinding.cs

@@ -187,7 +187,7 @@ procedural module contained in the enclosing project.
             var defaultInstanceVariableClass = _declarationFinder.FindDefaultInstanceVariableClassEnclosingProject(_project, _module, _name);
             if (defaultInstanceVariableClass != null)
             {
-                return new SimpleNameExpression(defaultInstanceVariableClass, ExpressionClassification.Type, _context);
+                return new SimpleNameExpression(defaultInstanceVariableClass, ExpressionClassification.Variable, _context);
             }
             return null;
         }

Rubberduck.Parsing/Symbols/VariableDeclaration.cs

@@ -23,7 +23,8 @@ public VariableDeclaration(
             bool isArray,
             VBAParser.AsTypeClauseContext asTypeContext,
             IEnumerable<IParseTreeAnnotation> annotations = null,
-            Attributes attributes = null)
+            Attributes attributes = null, 
+            bool isUserDefined = true)
             : base(
                 qualifiedName,
                 parentDeclaration,
@@ -39,7 +40,7 @@ public VariableDeclaration(
                 selection,
                 isArray,
                 asTypeContext,
-                true,
+                isUserDefined,
                 annotations,
                 attributes)
         {

Rubberduck.Parsing/VBA/DeclarationCaching/DeclarationFinder.cs

@@ -333,7 +333,7 @@ public IEnumerable<ModuleBodyElementDeclaration> FindEventHandlers(Declaration e
         {
             var withEventsDeclarations = FindWithEventFields(eventDeclaration);
             return withEventsDeclarations
-                .Select(withEventsField => FindHandlersForWithEventsField(withEventsField).Single(handler => 
+                .Select(withEventsField => FindHandlersForWithEventsField(withEventsField).SingleOrDefault(handler => 
                     handler.IdentifierName.Equals($"{withEventsField.IdentifierName}_{eventDeclaration.IdentifierName}", StringComparison.InvariantCultureIgnoreCase)));
         }
 
@@ -357,6 +357,18 @@ public ICollection<Declaration> FindFormEventHandlers()
         public IEnumerable<Declaration> Classes => _classes.Value;
         public IEnumerable<Declaration> Projects => _projects.Value;
 
+        /// <summary>
+        /// Gets the <see cref="ProjectDeclaration"/> object for specified referenced project/library.
+        /// </summary>
+        /// <param name="name">The identifier name of the project declaration to find.</param>
+        /// <param name="result">The <see cref="ProjectDeclaration"/> result, if found; null otherwise.</param>
+        /// <param name="includeUserDefined">True to include user-defined projects in the search; false by default.</param>
+        public bool TryFindProjectDeclaration(string name, out Declaration result, bool includeUserDefined = false)
+        {
+            result = _projects.Value.FirstOrDefault(project => project.IdentifierName.Equals(name, StringComparison.InvariantCultureIgnoreCase) && project.IsUserDefined == includeUserDefined);
+            return result != null;
+        }
+
         public IEnumerable<Declaration> UserDeclarations(DeclarationType type)
         {
             return _userDeclarationsByType.TryGetValue(type, out var result)
@@ -898,9 +910,10 @@ public Declaration FindMemberWithParent(Declaration callingProject, Declaration
             string memberName, DeclarationType memberType)
         {
             var allMatches = MatchName(memberName);
+            var parentClass = parent as ClassModuleDeclaration;
             var memberMatches = allMatches
                 .Where(m => m.DeclarationType.HasFlag(memberType)
-                            && parent.Equals(m.ParentDeclaration))
+                            && (parent.Equals(m.ParentDeclaration) || (parentClass?.Supertypes.Any(t => t.Equals(m.ParentDeclaration)) ?? false)))
                 .ToList();
             var accessibleMembers = memberMatches.Where(m => AccessibilityCheck.IsMemberAccessible(callingProject, callingModule, callingParent, m));
             var match = accessibleMembers.FirstOrDefault();
@@ -934,21 +947,23 @@ public Declaration FindMemberEnclosingModule(Declaration callingModule, Declarat
             }
             // Classes such as Worksheet have properties such as Range that can be access in a user defined class such as Sheet1,
             // that's why we have to walk the type hierarchy and find these implementations.
-            foreach (var supertype in ClassModuleDeclaration.GetSupertypes(callingModule))
+            if (callingModule is ClassModuleDeclaration callingClass)
             {
-                // Only built-in classes such as Worksheet can be considered "real base classes".
-                // User created interfaces work differently and don't allow accessing accessing implementations.
-                if (supertype.IsUserDefined)
+                foreach (var supertype in callingClass.Supertypes)
                 {
-                    continue;
-                }
-                var supertypeMatch = FindMemberEnclosingModule(supertype, callingParent, memberName, memberType);
-                if (supertypeMatch != null)
-                {
-                    return supertypeMatch;
+                    // Only built-in classes such as Worksheet can be considered "real base classes".
+                    // User created interfaces work differently and don't allow accessing accessing implementations.
+                    if (supertype.IsUserDefined)
+                    {
+                        continue;
+                    }
+                    var supertypeMatch = FindMemberEnclosingModule(supertype, callingParent, memberName, memberType);
+                    if (supertypeMatch != null)
+                    {
+                        return supertypeMatch;
+                    }
                 }
             }
-
             return null;
         }
 

Rubberduck.Resources/RubberduckUI.Designer.cs

@@ -1892,4 +1892,7 @@ Do you want to proceed?</value>
   <data name="IndenterSettings_GroupRelatedProperties" xml:space="preserve">
     <value>Remove vertical space between related property members</value>
   </data>
+  <data name="DeclarationType_Document" xml:space="preserve">
+    <value>document</value>
+  </data>
 </root>

Rubberduck.Resources/RubberduckUI.resx

@@ -527,7 +527,7 @@ Dim sht As WorkSheet
                 .AddProjectToVbeBuilder()
                 .Build();
 
-            var (expected, actual) = DeclarationsFromParse(vbe.Object, DeclarationType.Parameter, "Link", "EXCEL.EXE;Excel.Worksheet.Paste");
+            var (expected, actual) = DeclarationsFromParse(vbe.Object, DeclarationType.Parameter, "Link", "EXCEL.EXE;Excel._Worksheet.Paste");
 
             Assert.AreEqual(expected, actual);
         }