Skip to content

Commit 9ad77b1

Browse files
retailcoderretailcoder
authored
Merge pull request #6238 from retailcoder/inspections-cleanup
Various inspection-related clean-ups, fixes, and enhancements
2 parents cc26274 + bc540d1 commit 9ad77b1

File tree

170 files changed

+2865
-1831
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

170 files changed

+2865
-1831
lines changed

‎Rubberduck.CodeAnalysis/CodeAnalysisUI.Designer.cs‎

Lines changed: 18 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎Rubberduck.CodeAnalysis/CodeAnalysisUI.fr.resx‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,4 +263,10 @@
263263
<data name="CodeInspectionSettingsPage_FilterBySeverity" xml:space="preserve">
264264
<value>Sévérité:</value>
265265
</data>
266+
<data name="CodeInspectionSettingsPage_Misc_IgnoreFormControlHungarianNotation" xml:space="preserve">
267+
<value>Ignorer la notation hongroise pour les contrôles des UserForm</value>
268+
</data>
269+
<data name="InconsistentArrayBaseInspection_ParamArray" xml:space="preserve">
270+
<value>Le tableau de paramètres (ParamArray) '{0}' a zéro pour base.</value>
271+
</data>
266272
</root>

‎Rubberduck.CodeAnalysis/CodeAnalysisUI.resx‎

Lines changed: 86 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -1,76 +1,96 @@
11
<?xml version="1.0" encoding="utf-8"?>
22
<root>
33
<!--
4-
Microsoft ResX Schema
4+
Microsoft ResX Schema
5+
6+
Version 2.0
7+
8+
The primary goals of this format is to allow a simple XML format
9+
that is mostly human readable. The generation and parsing of the
10+
various data types are done through the TypeConverter classes
11+
associated with the data types.
12+
13+
Example:
14+
15+
... ado.net/XML headers & schema ...
16+
<resheader name="resmimetype">text/microsoft-resx</resheader>
17+
<resheader name="version">2.0</resheader>
18+
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19+
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20+
<data name="Name1"><value>this is my long string</value><comment>this is a comment</comment></data>
21+
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22+
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23+
<value>[base64 mime encoded serialized .NET Framework object]</value>
24+
</data>
25+
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26+
<value>[base64 mime encoded string representing a byte array form of the .NET Framework object]</value>
27+
<comment>This is a comment</comment>
28+
</data>
29+
30+
There are any number of "resheader" rows that contain simple
31+
name/value pairs.
32+
33+
Each data row contains a name, and value. The row also contains a
34+
type or mimetype. Type corresponds to a .NET class that support
35+
text/value conversion through the TypeConverter architecture.
36+
Classes that don't support this are serialized and stored with the
37+
mimetype set.
38+
39+
The mimetype is used for serialized objects, and tells the
40+
ResXResourceReader how to depersist the object. This is currently not
41+
extensible. For a given mimetype the value must be set accordingly:
42+
43+
Note - application/x-microsoft.net.object.binary.base64 is the format
44+
that the ResXResourceWriter will generate, however the reader can
45+
read any of the formats listed below.
46+
47+
mimetype: application/x-microsoft.net.object.binary.base64
48+
value : The object must be serialized with
49+
: System.Runtime.Serialization.Formatters.Binary.BinaryFormatter
50+
: and then encoded with base64 encoding.
51+
52+
mimetype: application/x-microsoft.net.object.soap.base64
53+
value : The object must be serialized with
54+
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
55+
: and then encoded with base64 encoding.
556
6-
Version 1.3
7-
8-
The primary goals of this format is to allow a simple XML format
9-
that is mostly human readable. The generation and parsing of the
10-
various data types are done through the TypeConverter classes
11-
associated with the data types.
12-
13-
Example:
14-
15-
... ado.net/XML headers & schema ...
16-
<resheader name="resmimetype">text/microsoft-resx</resheader>
17-
<resheader name="version">1.3</resheader>
18-
<resheader name="reader">System.Resources.ResXResourceReader, System.Windows.Forms, ...</resheader>
19-
<resheader name="writer">System.Resources.ResXResourceWriter, System.Windows.Forms, ...</resheader>
20-
<data name="Name1">this is my long string</data>
21-
<data name="Color1" type="System.Drawing.Color, System.Drawing">Blue</data>
22-
<data name="Bitmap1" mimetype="application/x-microsoft.net.object.binary.base64">
23-
[base64 mime encoded serialized .NET Framework object]
24-
</data>
25-
<data name="Icon1" type="System.Drawing.Icon, System.Drawing" mimetype="application/x-microsoft.net.object.bytearray.base64">
26-
[base64 mime encoded string representing a byte array form of the .NET Framework object]
27-
</data>
28-
29-
There are any number of "resheader" rows that contain simple
30-
name/value pairs.
31-
32-
Each data row contains a name, and value. The row also contains a
33-
type or mimetype. Type corresponds to a .NET class that support
34-
text/value conversion through the TypeConverter architecture.
35-
Classes that don't support this are serialized and stored with the
36-
mimetype set.
37-
38-
The mimetype is used for serialized objects, and tells the
39-
ResXResourceReader how to depersist the object. This is currently not
40-
extensible. For a given mimetype the value must be set accordingly:
41-
42-
Note - application/x-microsoft.net.object.binary.base64 is the format
43-
that the ResXResourceWriter will generate, however the reader can
44-
read any of the formats listed below.
45-
46-
mimetype: application/x-microsoft.net.object.binary.base64
47-
value : The object must be serialized with
48-
: System.Serialization.Formatters.Binary.BinaryFormatter
49-
: and then encoded with base64 encoding.
50-
51-
mimetype: application/x-microsoft.net.object.soap.base64
52-
value : The object must be serialized with
53-
: System.Runtime.Serialization.Formatters.Soap.SoapFormatter
54-
: and then encoded with base64 encoding.
55-
56-
mimetype: application/x-microsoft.net.object.bytearray.base64
57-
value : The object must be serialized into a byte array
58-
: using a System.ComponentModel.TypeConverter
59-
: and then encoded with base64 encoding.
60-
-->
57+
mimetype: application/x-microsoft.net.object.bytearray.base64
58+
value : The object must be serialized into a byte array
59+
: using a System.ComponentModel.TypeConverter
60+
: and then encoded with base64 encoding.
61+
-->
6162
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
63+
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
6264
<xsd:element name="root" msdata:IsDataSet="true">
6365
<xsd:complexType>
6466
<xsd:choice maxOccurs="unbounded">
67+
<xsd:element name="metadata">
68+
<xsd:complexType>
69+
<xsd:sequence>
70+
<xsd:element name="value" type="xsd:string" minOccurs="0" />
71+
</xsd:sequence>
72+
<xsd:attribute name="name" use="required" type="xsd:string" />
73+
<xsd:attribute name="type" type="xsd:string" />
74+
<xsd:attribute name="mimetype" type="xsd:string" />
75+
<xsd:attribute ref="xml:space" />
76+
</xsd:complexType>
77+
</xsd:element>
78+
<xsd:element name="assembly">
79+
<xsd:complexType>
80+
<xsd:attribute name="alias" type="xsd:string" />
81+
<xsd:attribute name="name" type="xsd:string" />
82+
</xsd:complexType>
83+
</xsd:element>
6584
<xsd:element name="data">
6685
<xsd:complexType>
6786
<xsd:sequence>
6887
<xsd:element name="value" type="xsd:string" minOccurs="0" msdata:Ordinal="1" />
6988
<xsd:element name="comment" type="xsd:string" minOccurs="0" msdata:Ordinal="2" />
7089
</xsd:sequence>
71-
<xsd:attribute name="name" type="xsd:string" msdata:Ordinal="1" />
90+
<xsd:attribute name="name" type="xsd:string" use="required" msdata:Ordinal="1" />
7291
<xsd:attribute name="type" type="xsd:string" msdata:Ordinal="3" />
7392
<xsd:attribute name="mimetype" type="xsd:string" msdata:Ordinal="4" />
93+
<xsd:attribute ref="xml:space" />
7494
</xsd:complexType>
7595
</xsd:element>
7696
<xsd:element name="resheader">
@@ -89,13 +109,13 @@
89109
<value>text/microsoft-resx</value>
90110
</resheader>
91111
<resheader name="version">
92-
<value>1.3</value>
112+
<value>2.0</value>
93113
</resheader>
94114
<resheader name="reader">
95-
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=2.0.3500.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
115+
<value>System.Resources.ResXResourceReader, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
96116
</resheader>
97117
<resheader name="writer">
98-
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=2.0.3500.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
118+
<value>System.Resources.ResXResourceWriter, System.Windows.Forms, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b77a5c561934e089</value>
99119
</resheader>
100120
<data name="CodeInspectionResults_Type" xml:space="preserve">
101121
<value>Type</value>
@@ -245,4 +265,10 @@
245265
<data name="CodeInspectionSettingsPage_FilterBySeverity" xml:space="preserve">
246266
<value>Severity:</value>
247267
</data>
268+
<data name="CodeInspectionSettingsPage_Misc_IgnoreFormControlHungarianNotation" xml:space="preserve">
269+
<value>Ignore Hungarian Notation for UserForm controls</value>
270+
</data>
271+
<data name="InconsistentArrayBaseInspection_ParamArray" xml:space="preserve">
272+
<value>Parameter array '{0}' is zero-based.</value>
273+
</data>
248274
</root>

‎Rubberduck.CodeAnalysis/Inspections/Abstract/InvalidAnnotationInspectionBase.cs‎

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
using Rubberduck.CodeAnalysis.Inspections.Results;
2+
using Rubberduck.Parsing;
3+
using Rubberduck.Parsing.Annotations;
4+
using Rubberduck.Parsing.Symbols;
5+
using Rubberduck.Parsing.VBA;
6+
using Rubberduck.Parsing.VBA.DeclarationCaching;
7+
using Rubberduck.VBEditor;
8+
using System.Collections.Generic;
9+
using System.Linq;
10+
11+
namespace Rubberduck.CodeAnalysis.Inspections.Abstract
12+
{
13+
/// <summary>
14+
/// An inspection that flags invalid annotation comments.
15+
/// </summary>
16+
internal abstract class InvalidAnnotationInspectionBase : InspectionBase
17+
{
18+
protected InvalidAnnotationInspectionBase(IDeclarationFinderProvider declarationFinderProvider)
19+
: base(declarationFinderProvider) { }
20+
21+
protected QualifiedContext Context(IParseTreeAnnotation pta) =>
22+
new QualifiedContext(pta.QualifiedSelection.QualifiedName, pta.Context);
23+
24+
protected sealed override IEnumerable<IInspectionResult> DoGetInspectionResults(DeclarationFinder finder)
25+
{
26+
return finder.UserDeclarations(DeclarationType.Module)
27+
.Where(module => module != null)
28+
.SelectMany(module => DoGetInspectionResults(module.QualifiedModuleName, finder));
29+
}
30+
31+
protected IInspectionResult InspectionResult(IParseTreeAnnotation pta) =>
32+
new QualifiedContextInspectionResult(this, ResultDescription(pta), Context(pta));
33+
34+
/// <summary>
35+
/// Gets all invalid annotations covered by this inspection.
36+
/// </summary>
37+
/// <param name="annotations">All user code annotations.</param>
38+
/// <param name="userDeclarations">All user declarations.</param>
39+
/// <param name="identifierReferences">All identifier references in user code.</param>
40+
/// <returns></returns>
41+
protected abstract IEnumerable<IParseTreeAnnotation> GetInvalidAnnotations(
42+
IEnumerable<IParseTreeAnnotation> annotations,
43+
IEnumerable<Declaration> userDeclarations,
44+
IEnumerable<IdentifierReference> identifierReferences);
45+
46+
/// <summary>
47+
/// Gets an annotation-specific description for an inspection result.
48+
/// </summary>
49+
/// <param name="pta">The invalid annotation.</param>
50+
/// <returns></returns>
51+
protected abstract string ResultDescription(IParseTreeAnnotation pta);
52+
53+
protected sealed override IEnumerable<IInspectionResult> DoGetInspectionResults(QualifiedModuleName module, DeclarationFinder finder)
54+
{
55+
var annotations = finder.FindAnnotations(module);
56+
var userDeclarations = finder.Members(module).ToList();
57+
var identifierReferences = finder.IdentifierReferences(module).ToList();
58+
59+
var invalidAnnotations = GetInvalidAnnotations(annotations, userDeclarations, identifierReferences);
60+
return invalidAnnotations.Select(InspectionResult).ToList();
61+
}
62+
}
63+
}

‎Rubberduck.CodeAnalysis/Inspections/Concrete/AnnotationInIncompatibleComponentTypeInspection.cs‎

Lines changed: 80 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,80 @@
1+
using Rubberduck.CodeAnalysis.Inspections.Abstract;
2+
using Rubberduck.Parsing;
3+
using Rubberduck.Parsing.Annotations;
4+
using Rubberduck.Parsing.Symbols;
5+
using Rubberduck.Parsing.VBA;
6+
using Rubberduck.Resources.Inspections;
7+
using System.Collections.Generic;
8+
using System.Globalization;
9+
using System.Linq;
10+
11+
namespace Rubberduck.CodeAnalysis.Inspections.Concrete
12+
{
13+
/// <summary>
14+
/// Flags Rubberduck annotations used in a component type that is incompatible with that annotation.
15+
/// </summary>
16+
/// <why>
17+
/// Some annotations can only be used in a specific type of module; others cannot be used in certain types of modules.
18+
/// </why>
19+
/// <example hasResult="true">
20+
/// <module name="MyModule" type="Standard Module">
21+
/// <![CDATA[
22+
/// '@PredeclaredId 'this annotation is illegal in a standard module
23+
/// Option Explicit
24+
/// ]]>
25+
/// </module>
26+
/// </example>
27+
/// <example hasResult="false">
28+
/// <module name="MyModule" type="Class Module">
29+
/// <![CDATA[
30+
/// '@PredeclaredId 'this annotation works fine in a class module
31+
/// Option Explicit
32+
///
33+
/// Public Sub DoSomething()
34+
/// Dim foo As Long
35+
/// End Sub
36+
/// ]]>
37+
/// </module>
38+
/// </example>
39+
internal sealed class AnnotationInIncompatibleComponentTypeInspection : InvalidAnnotationInspectionBase
40+
{
41+
public AnnotationInIncompatibleComponentTypeInspection(IDeclarationFinderProvider declarationFinderProvider)
42+
: base(declarationFinderProvider) { }
43+
44+
protected override IEnumerable<IParseTreeAnnotation> GetInvalidAnnotations(
45+
IEnumerable<IParseTreeAnnotation> annotations,
46+
IEnumerable<Declaration> userDeclarations,
47+
IEnumerable<IdentifierReference> identifierReferences)
48+
{
49+
foreach (var pta in annotations)
50+
{
51+
var annotation = pta.Annotation;
52+
var componentType = pta.QualifiedSelection.QualifiedName.ComponentType;
53+
if (annotation.RequiredComponentType.HasValue && annotation.RequiredComponentType != componentType
54+
|| annotation.IncompatibleComponentTypes.Contains(componentType))
55+
{
56+
yield return pta;
57+
}
58+
}
59+
60+
yield break;
61+
}
62+
63+
protected override string ResultDescription(IParseTreeAnnotation pta)
64+
{
65+
if (pta.Annotation.RequiredComponentType.HasValue)
66+
{
67+
return string.Format(InspectionResults.ResourceManager.GetString($"{nameof(InvalidAnnotationInspection)}_NotInRequiredComponentType", CultureInfo.CurrentUICulture),
68+
pta.Annotation.Name, // annotation...
69+
pta.QualifiedSelection.QualifiedName.ComponentType, // is used in a...
70+
pta.Annotation.RequiredComponentType); // but is only valid in a...
71+
}
72+
else
73+
{
74+
return string.Format(InspectionResults.ResourceManager.GetString($"{nameof(InvalidAnnotationInspection)}_IncompatibleComponentType", CultureInfo.CurrentUICulture),
75+
pta.Annotation.Name, // annotation...
76+
pta.QualifiedSelection.QualifiedName.ComponentType); // cannot be used in a...
77+
}
78+
}
79+
}
80+
}

0 commit comments

Comments
 (0)