Merge pull request #4021 from mansellan/3993

retailcoder · web-flow · commit 15fc99324489 · 2018-06-03T20:21:01.000-04:00
VB6 - Exclude ResFile and RelatedDocument from parse
diff --git a/Rubberduck.Core/Navigation/CodeExplorer/CodeExplorerComponentViewModel.cs b/Rubberduck.Core/Navigation/CodeExplorer/CodeExplorerComponentViewModel.cs
@@ -1,5 +1,6 @@
 using System;
 using System.Collections.Generic;
+using System.IO;
 using System.Linq;
 using System.Runtime.InteropServices;
 using System.Windows.Media.Imaging;
@@ -61,29 +62,44 @@ public CodeExplorerComponentViewModel(CodeExplorerItemViewModel parent, Declarat
             var qualifiedModuleName = declaration.QualifiedName.QualifiedModuleName;
             try
             {
-                if (qualifiedModuleName.ComponentType == ComponentType.Document)
+                switch (qualifiedModuleName.ComponentType)
                 {
-                    var component = _projectsProvider.Component(qualifiedModuleName);
-                    string parenthesizedName;
-                    using (var properties = component.Properties)
-                    {
-                        parenthesizedName = properties["Name"].Value.ToString() ?? String.Empty;
-                    }
-
-                    if (ContainsBuiltinDocumentPropertiesProperty())
-                    {
-                        CodeExplorerItemViewModel node = this;
-                        while (node.Parent != null)
+                    case ComponentType.Document:
+                        var component = _projectsProvider.Component(qualifiedModuleName);
+                        string parenthesizedName;
+                        using (var properties = component.Properties)
                         {
-                            node = node.Parent;
+                            parenthesizedName = properties["Name"].Value.ToString() ?? string.Empty;
                         }
 
-                        ((CodeExplorerProjectViewModel) node).SetParenthesizedName(parenthesizedName);
-                    }
-                    else
-                    {
-                        _name += " (" + parenthesizedName + ")";
-                    }
+                        if (ContainsBuiltinDocumentPropertiesProperty())
+                        {
+                            CodeExplorerItemViewModel node = this;
+                            while (node.Parent != null)
+                            {
+                                node = node.Parent;
+                            }
+
+                            ((CodeExplorerProjectViewModel) node).SetParenthesizedName(parenthesizedName);
+                        }
+                        else
+                        {
+                            _name += " (" + parenthesizedName + ")";
+                        }
+                        break;
+
+                    case ComponentType.ResFile:
+                        var fileName = Declaration.IdentifierName.Split('\\').Last();
+                        _name = $"{CodeExplorerUI.CodeExplorer_ResourceFileText} ({fileName})";
+                        break;
+
+                    case ComponentType.RelatedDocument:
+                        _name = $"({Declaration.IdentifierName.Split('\\').Last()})";
+                        break;
+
+                    default:
+                        _name = Declaration.IdentifierName;
+                        break;
                 }
             }
             catch
@@ -183,7 +199,8 @@ private DeclarationType DeclarationType
             { DeclarationType.DocObject, GetImageSource(CodeExplorerUI.document_globe)},
             { DeclarationType.PropPage, GetImageSource(CodeExplorerUI.ui_tab_content)},
             { DeclarationType.ActiveXDesigner, GetImageSource(CodeExplorerUI.pencil_ruler)},
-            { DeclarationType.ResFile, GetImageSource(CodeExplorerUI.document_block)}
+            { DeclarationType.ResFile, GetImageSource(CodeExplorerUI.document_block)},
+            { DeclarationType.RelatedDocument, GetImageSource(CodeExplorerUI.document_import)}
         };
 
         private BitmapImage _icon;
diff --git a/Rubberduck.Parsing/VBA/ParseRunner.cs b/Rubberduck.Parsing/VBA/ParseRunner.cs
@@ -44,7 +44,10 @@ public override void ParseModules(IReadOnlyCollection<QualifiedModuleName> modul
                     options,
                     module =>
                     {
-                        ParseModule(module, token);
+                        if (module.IsParsable)
+                        {
+                            ParseModule(module, token);
+                        }
                     }
                 );
             }
diff --git a/Rubberduck.Parsing/VBA/ReferenceResolveRunnerBase.cs b/Rubberduck.Parsing/VBA/ReferenceResolveRunnerBase.cs
@@ -63,7 +63,7 @@ public void ResolveReferences(IReadOnlyCollection<QualifiedModuleName> toResolve
         {
             token.ThrowIfCancellationRequested();
 
-            _toResolve.UnionWith(toResolve);
+            _toResolve.UnionWith(toResolve.Where(qmn => qmn.IsParsable));
             token.ThrowIfCancellationRequested();
 
             if(!_toResolve.Any())
diff --git a/Rubberduck.Parsing/VBA/RubberduckParserState.cs b/Rubberduck.Parsing/VBA/RubberduckParserState.cs
@@ -418,7 +418,7 @@ private ParserState OverallParserStateFromModuleStates()
             var moduleStates = new List<ParserState>();
             foreach (var moduleState in _moduleStates)
             {
-                if (string.IsNullOrEmpty(moduleState.Key.ComponentName) || ProjectsProvider.Component(moduleState.Key) == null)
+                if (string.IsNullOrEmpty(moduleState.Key.ComponentName) || ProjectsProvider.Component(moduleState.Key) == null || !moduleState.Key.IsParsable)
                 {
                     continue;
                 }
diff --git a/Rubberduck.Resources/CodeExplorer/CodeExplorerUI.Designer.cs b/Rubberduck.Resources/CodeExplorer/CodeExplorerUI.Designer.cs
diff --git a/Rubberduck.Resources/CodeExplorer/CodeExplorerUI.resx b/Rubberduck.Resources/CodeExplorer/CodeExplorerUI.resx
@@ -223,6 +223,9 @@
   <data name="ui_tab_content" type="System.Resources.ResXFileRef, System.Windows.Forms">
     <value>..\icons\fugue\ui-tab-content.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
   </data>
+  <data name="document_import" type="System.Resources.ResXFileRef, System.Windows.Forms">
+    <value>..\Icons\Fugue\document-import.png;System.Drawing.Bitmap, System.Drawing, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a</value>
+  </data>
   <data name="CodeExplorerDockablePresenter_Caption" xml:space="preserve">
     <value>Code Explorer</value>
   </data>
diff --git a/Rubberduck.Resources/Icons/Fugue/document-import.png b/Rubberduck.Resources/Icons/Fugue/document-import.png
diff --git a/Rubberduck.Resources/Rubberduck.Resources.csproj b/Rubberduck.Resources/Rubberduck.Resources.csproj
@@ -647,6 +647,7 @@
     <Resource Include="Icons\Fugue\ui-scroll-pane-form.png" />
     <Resource Include="Icons\Fugue\ui-tab-content.png" />
     <Content Include="Icons\Custom\PNG\MdiForm.png" />
+    <Resource Include="Icons\Fugue\document-import.png" />
     <Content Include="Splash.png" />
     <Resource Include="Icons\Fugue\lock--exclamation.png" />
     <Resource Include="Rubberduck.png" />
diff --git a/Rubberduck.VBEEditor/QualifiedModuleName.cs b/Rubberduck.VBEEditor/QualifiedModuleName.cs
@@ -35,7 +35,7 @@ public static string GetProjectId(IReference reference)
 
         public static int GetModuleContentHash(IVBComponent component)
         {
-            if (component == null || component.IsWrappingNullReference)
+            if (component == null || component.IsWrappingNullReference || !component.HasCodeModule)
             {
                 return 0;
             }
@@ -103,6 +103,7 @@ public QualifiedMemberName QualifyMemberName(string member)
 
         public ComponentType ComponentType { get; }
 
+        public bool IsParsable => ComponentType != ComponentType.ResFile && ComponentType != ComponentType.RelatedDocument;
         public string ProjectId { get; }
 
         private readonly string _componentName;
diff --git a/Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBComponent.cs b/Rubberduck.VBEEditor/SafeComWrappers/VB/Abstract/IVBComponent.cs
@@ -5,6 +5,7 @@ namespace Rubberduck.VBEditor.SafeComWrappers.Abstract
     public interface IVBComponent : ISafeComWrapper, IEquatable<IVBComponent>
     {
         ComponentType Type { get; }
+        bool HasCodeModule { get; }
         ICodeModule CodeModule { get; }
         IVBE VBE { get; }
         IVBComponents Collection { get; }
diff --git a/Rubberduck.VBEditor.VB6/SafeComWrappers/VB/VBComponent.cs b/Rubberduck.VBEditor.VB6/SafeComWrappers/VB/VBComponent.cs
@@ -1,8 +1,7 @@
 using System;
+using System.Diagnostics;
 using System.IO;
 using System.Linq;
-using System.Text;
-using Rubberduck.VBEditor.Extensions;
 using Rubberduck.VBEditor.SafeComWrappers.Abstract;
 using VB = Microsoft.Vbe.Interop.VB6;
 
@@ -18,7 +17,20 @@ public VBComponent(VB.VBComponent target, bool rewrapping = false)
         public QualifiedModuleName QualifiedModuleName => new QualifiedModuleName(this);
 
         public ComponentType Type => IsWrappingNullReference ? 0 : (ComponentType)Target.Type;
-        public ICodeModule CodeModule => new CodeModule(IsWrappingNullReference ? null : Target.CodeModule);
+
+        public bool HasCodeModule => Type != ComponentType.RelatedDocument && Type != ComponentType.ResFile;
+        public ICodeModule CodeModule
+        {
+            get
+            {                
+                if (!IsWrappingNullReference && HasCodeModule)
+                {
+                    return new CodeModule(Target.CodeModule);
+                }
+                return new CodeModule(null);
+            }
+        }
+
         public IVBE VBE => new VBE(IsWrappingNullReference ? null : Target.VBE);
         public IVBComponents Collection => new VBComponents(IsWrappingNullReference ? null : Target.Collection);
         public IProperties Properties => new Properties(IsWrappingNullReference ? null : Target.Properties);
@@ -27,7 +39,24 @@ public VBComponent(VB.VBComponent target, bool rewrapping = false)
 
         public string Name
         {
-            get => IsWrappingNullReference ? string.Empty : Target.Name;
+            get
+            {
+                if (IsWrappingNullReference)
+                {
+                    return string.Empty;
+                }
+                if (!string.IsNullOrEmpty(Target.Name))
+                {
+                    return Target.Name;
+                }
+                if (FileCount > 0)
+                {
+                    return GetFileName(1);
+                }
+
+                Debug.Assert(false, "Could not get component name");
+                return string.Empty;
+            }
             set
             {
                 if (!IsWrappingNullReference)
diff --git a/Rubberduck.VBEditor.VBA/SafeComWrappers/VB/VBComponent.cs b/Rubberduck.VBEditor.VBA/SafeComWrappers/VB/VBComponent.cs
@@ -18,6 +18,7 @@ public VBComponent(VB.VBComponent target, bool rewrapping = false)
         public QualifiedModuleName QualifiedModuleName => new QualifiedModuleName(this);
 
         public ComponentType Type => IsWrappingNullReference ? 0 : (ComponentType)Target.Type;
+        public bool HasCodeModule => true;
         public ICodeModule CodeModule => new CodeModule(IsWrappingNullReference ? null : Target.CodeModule);
         public IVBE VBE => new VBE(IsWrappingNullReference ? null : Target.VBE);
         public IVBComponents Collection => new VBComponents(IsWrappingNullReference ? null : Target.Collection);
diff --git a/RubberduckTests/Mocks/MockProjectBuilder.cs b/RubberduckTests/Mocks/MockProjectBuilder.cs
@@ -273,6 +273,7 @@ private Mock<IVBComponent> CreateComponentMock(string name, ComponentType type,
             result.SetupGet(m => m.VBE).Returns(_getVbe);
             result.SetupGet(m => m.Collection).Returns(() => _vbComponents.Object);
             result.SetupGet(m => m.Type).Returns(() => type);
+            result.SetupGet(m => m.HasCodeModule).Returns(true);
             result.SetupProperty(m => m.Name, name);
             result.SetupGet(m => m.QualifiedModuleName).Returns(() => new QualifiedModuleName(result.Object));
 

Original file line number	Diff line number	Diff line change
`@@ -44,7 +44,10 @@ public override void ParseModules(IReadOnlyCollection<QualifiedModuleName> modul`
`44`	`44`	`options,`
`45`	`45`	`module =>`
`46`	`46`	`{`
`47`		`- ParseModule(module, token);`
	`47`	`+ if (module.IsParsable)`
	`48`	`+ {`
	`49`	`+ ParseModule(module, token);`
	`50`	`+ }`
`48`	`51`	`}`
`49`	`52`	`);`
`50`	`53`	`}`
Original file line number	Diff line number	Diff line change
`@@ -63,7 +63,7 @@ public void ResolveReferences(IReadOnlyCollection<QualifiedModuleName> toResolve`
`63`	`63`	`{`
`64`	`64`	`token.ThrowIfCancellationRequested();`
`65`	`65`
`66`		`- _toResolve.UnionWith(toResolve);`
	`66`	`+ _toResolve.UnionWith(toResolve.Where(qmn => qmn.IsParsable));`
`67`	`67`	`token.ThrowIfCancellationRequested();`
`68`	`68`
`69`	`69`	`if(!_toResolve.Any())`
Original file line number	Diff line number	Diff line change
`@@ -418,7 +418,7 @@ private ParserState OverallParserStateFromModuleStates()`
`418`	`418`	`var moduleStates = new List<ParserState>();`
`419`	`419`	`foreach (var moduleState in _moduleStates)`
`420`	`420`	`{`
`421`		`- if (string.IsNullOrEmpty(moduleState.Key.ComponentName) \|\| ProjectsProvider.Component(moduleState.Key) == null)`
	`421`	`+ if (string.IsNullOrEmpty(moduleState.Key.ComponentName) \|\| ProjectsProvider.Component(moduleState.Key) == null \|\| !moduleState.Key.IsParsable)`
`422`	`422`	`{`
`423`	`423`	`continue;`
`424`	`424`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public static string GetProjectId(IReference reference)`
`35`	`35`
`36`	`36`	`public static int GetModuleContentHash(IVBComponent component)`
`37`	`37`	`{`
`38`		`- if (component == null \|\| component.IsWrappingNullReference)`
	`38`	`+ if (component == null \|\| component.IsWrappingNullReference \|\| !component.HasCodeModule)`
`39`	`39`	`{`
`40`	`40`	`return 0;`
`41`	`41`	`}`
`@@ -103,6 +103,7 @@ public QualifiedMemberName QualifyMemberName(string member)`
`103`	`103`
`104`	`104`	`public ComponentType ComponentType { get; }`
`105`	`105`
	`106`	`+ public bool IsParsable => ComponentType != ComponentType.ResFile && ComponentType != ComponentType.RelatedDocument;`
`106`	`107`	`public string ProjectId { get; }`
`107`	`108`
`108`	`109`	`private readonly string _componentName;`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@ namespace Rubberduck.VBEditor.SafeComWrappers.Abstract`
`5`	`5`	`public interface IVBComponent : ISafeComWrapper, IEquatable<IVBComponent>`
`6`	`6`	`{`
`7`	`7`	`ComponentType Type { get; }`
	`8`	`+ bool HasCodeModule { get; }`
`8`	`9`	`ICodeModule CodeModule { get; }`
`9`	`10`	`IVBE VBE { get; }`
`10`	`11`	`IVBComponents Collection { get; }`