Skip to content

Commit 2017e5a

Browse files
committed
closes #6206
1 parent 1d620f2 commit 2017e5a

File tree

9 files changed

+165
-103
lines changed

9 files changed

+165
-103
lines changed

Diff for: Rubberduck.CodeAnalysis/CodeAnalysisUI.Designer.cs

+10-1
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

Diff for: Rubberduck.CodeAnalysis/CodeAnalysisUI.fr.resx

+3
Original file line numberDiff line numberDiff line change
@@ -263,4 +263,7 @@
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>
266269
</root>

Diff for: Rubberduck.CodeAnalysis/CodeAnalysisUI.resx

+83-60
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,7 @@
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>
248271
</root>

Diff for: Rubberduck.CodeAnalysis/Inspections/Concrete/HungarianNotationInspection.cs

+8-5
Original file line numberDiff line numberDiff line change
@@ -80,19 +80,22 @@ public HungarianNotationInspection(IDeclarationFinderProvider declarationFinderP
8080
_settings = settings;
8181
}
8282

83+
private CodeInspectionSettings _configuration;
84+
8385
protected override List<string> GlobalInformation(DeclarationFinder finder)
8486
{
85-
var settings = _settings.Read();
86-
return settings.WhitelistedIdentifiers
87+
_configuration = _settings.Read();
88+
return _configuration.WhitelistedIdentifiers
8789
.Select(s => s.Identifier)
8890
.ToList();
8991
}
9092

9193
protected override bool IsResultDeclaration(Declaration declaration, DeclarationFinder finder, List<string> whitelistedNames)
9294
{
93-
return !whitelistedNames.Contains(declaration.IdentifierName)
94-
&& !IgnoredProcedureTypes.Contains(declaration.ParentDeclaration.DeclarationType)
95-
&& declaration.IdentifierName.TryMatchHungarianNotationCriteria(out _);
95+
return (_configuration.IgnoreFormControlsHungarianNotation || declaration.DeclarationType == DeclarationType.Control)
96+
&& !whitelistedNames.Contains(declaration.IdentifierName)
97+
&& !IgnoredProcedureTypes.Contains(declaration.ParentDeclaration.DeclarationType)
98+
&& declaration.IdentifierName.TryMatchHungarianNotationCriteria(out _);
9699
}
97100

98101
protected override string ResultDescription(Declaration declaration)

Diff for: Rubberduck.CodeAnalysis/Settings/CodeInspectionSettings.cs

+11-6
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
using System;
1+
using Rubberduck.CodeAnalysis.Inspections;
2+
using System;
23
using System.Collections.Generic;
34
using System.Configuration;
45
using System.Globalization;
56
using System.Linq;
67
using System.Xml.Serialization;
7-
using Rubberduck.CodeAnalysis.Inspections;
88

99
namespace Rubberduck.CodeAnalysis.Settings
1010
{
@@ -13,6 +13,8 @@ public interface ICodeInspectionSettings
1313
HashSet<CodeInspectionSetting> CodeInspections { get; set; }
1414
WhitelistedIdentifierSetting[] WhitelistedIdentifiers { get; set; }
1515
bool RunInspectionsOnSuccessfulParse { get; set; }
16+
17+
bool IgnoreFormControlsHungarianNotation { get; set; }
1618
}
1719

1820
[SettingsSerializeAs(SettingsSerializeAs.Xml)]
@@ -26,16 +28,18 @@ public class CodeInspectionSettings : ICodeInspectionSettings, IEquatable<CodeIn
2628
public WhitelistedIdentifierSetting[] WhitelistedIdentifiers { get; set; }
2729

2830
public bool RunInspectionsOnSuccessfulParse { get; set; }
31+
public bool IgnoreFormControlsHungarianNotation { get; set; }
2932

30-
public CodeInspectionSettings() : this(Enumerable.Empty<CodeInspectionSetting>(), new WhitelistedIdentifierSetting[] { }, true)
33+
public CodeInspectionSettings() : this(Enumerable.Empty<CodeInspectionSetting>(), new WhitelistedIdentifierSetting[] { }, true, false)
3134
{
3235
}
3336

34-
public CodeInspectionSettings(IEnumerable<CodeInspectionSetting> inspections, WhitelistedIdentifierSetting[] whitelistedNames, bool runInspectionsOnParse)
37+
public CodeInspectionSettings(IEnumerable<CodeInspectionSetting> inspections, WhitelistedIdentifierSetting[] whitelistedNames, bool runInspectionsOnParse, bool ignoreFormControlsHungarian)
3538
{
3639
CodeInspections = new HashSet<CodeInspectionSetting>(inspections);
3740
WhitelistedIdentifiers = whitelistedNames;
3841
RunInspectionsOnSuccessfulParse = runInspectionsOnParse;
42+
IgnoreFormControlsHungarianNotation = ignoreFormControlsHungarian;
3943
}
4044

4145
public CodeInspectionSetting GetSetting<TInspection>() where TInspection : IInspection
@@ -53,7 +57,7 @@ public CodeInspectionSetting GetSetting(Type inspectionType)
5357
{
5458
return existing;
5559
}
56-
var proto = Convert.ChangeType(Activator.CreateInstance(inspectionType, new object[]{null}), inspectionType);
60+
var proto = Convert.ChangeType(Activator.CreateInstance(inspectionType, new object[] { null }), inspectionType);
5761
var setting = new CodeInspectionSetting(proto as IInspectionModel);
5862
CodeInspections.Add(setting);
5963
return setting;
@@ -69,7 +73,8 @@ public bool Equals(CodeInspectionSettings other)
6973
return other != null &&
7074
CodeInspections.SequenceEqual(other.CodeInspections) &&
7175
WhitelistedIdentifiers.SequenceEqual(other.WhitelistedIdentifiers) &&
72-
RunInspectionsOnSuccessfulParse == other.RunInspectionsOnSuccessfulParse;
76+
RunInspectionsOnSuccessfulParse == other.RunInspectionsOnSuccessfulParse &&
77+
IgnoreFormControlsHungarianNotation == other.IgnoreFormControlsHungarianNotation;
7378
}
7479
}
7580

Diff for: Rubberduck.Core/UI/Settings/InspectionSettings.xaml

+2
Original file line numberDiff line numberDiff line change
@@ -146,6 +146,8 @@
146146
<StackPanel>
147147
<CheckBox IsChecked="{Binding RunInspectionsOnSuccessfulParse}"
148148
Content="{Resx ResxName=Rubberduck.CodeAnalysis.CodeAnalysisUI, Key=CodeInspectionSettingsPage_Misc_RunInspectionsOnSuccessfulParse}" />
149+
<CheckBox IsChecked="{Binding IgnoreFormControlsHungarianNotation}"
150+
Content="{Resx ResxName=Rubberduck.CodeAnalysis.CodeAnalysisUI, Key=CodeInspectionSettingsPage_Misc_IgnoreFormControlHungarianNotation}" />
149151
</StackPanel>
150152

151153
<Border Style="{StaticResource BorderHeader}"

0 commit comments

Comments
 (0)