Skip to content

Commit d25e6a9

Browse files
Hosch250Hosch250
committed
Close #2185 
1 parent ff0d77c commit d25e6a9

File tree

9 files changed

+489
-4
lines changed

9 files changed

+489
-4
lines changed

‎RetailCoder.VBE/Inspections/Concrete/Inspector.cs

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,14 +126,16 @@ before moving them into the ParseTreeResults after qualifying them
126126
var emptyStringLiteralListener = IsDisabled<EmptyStringLiteralInspection>(settings) ? null : new EmptyStringLiteralInspection.EmptyStringLiteralListener();
127127
var argListWithOneByRefParamListener = IsDisabled<ProcedureCanBeWrittenAsFunctionInspection>(settings) ? null : new ProcedureCanBeWrittenAsFunctionInspection.SingleByRefParamArgListListener();
128128
var invalidAnnotationListener = IsDisabled<MissingAnnotationArgumentInspection>(settings) ? null : new MissingAnnotationArgumentInspection.InvalidAnnotationStatementListener();
129+
var optionBaseZeroListener = IsDisabled<OptionBaseZeroInspection>(settings) ? null : new OptionBaseZeroInspection.OptionBaseStatementListener();
129130

130131
var combinedListener = new CombinedParseTreeListener(new IParseTreeListener[]{
131132
obsoleteCallStatementListener,
132133
obsoleteLetStatementListener,
133134
obsoleteCommentSyntaxListener,
134135
emptyStringLiteralListener,
135136
argListWithOneByRefParamListener,
136-
invalidAnnotationListener
137+
invalidAnnotationListener,
138+
optionBaseZeroListener
137139
});
138140

139141
ParseTreeWalker.Default.Walk(combinedListener, componentTreePair.Value);
@@ -162,6 +164,10 @@ before moving them into the ParseTreeResults after qualifying them
162164
{
163165
result.AddRange(invalidAnnotationListener.Contexts.Select(context => new QualifiedContext<VBAParser.AnnotationContext>(componentTreePair.Key, context)));
164166
}
167+
if (optionBaseZeroListener != null)
168+
{
169+
result.AddRange(optionBaseZeroListener.Contexts.Select(context => new QualifiedContext<VBAParser.OptionBaseStmtContext>(componentTreePair.Key, context)));
170+
}
165171
}
166172
return result;
167173
}

‎RetailCoder.VBE/Inspections/OptionBaseZeroInspection.cs

Lines changed: 53 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,53 @@
1+
using System.Collections.Generic;
2+
using System.Linq;
3+
using Rubberduck.Inspections.Abstract;
4+
using Rubberduck.Inspections.Resources;
5+
using Rubberduck.Inspections.Results;
6+
using Rubberduck.Parsing;
7+
using Rubberduck.Parsing.Grammar;
8+
using Rubberduck.Parsing.VBA;
9+
10+
namespace Rubberduck.Inspections
11+
{
12+
public sealed class OptionBaseZeroInspection : InspectionBase, IParseTreeInspection<VBAParser.OptionBaseStmtContext>
13+
{
14+
private IEnumerable<QualifiedContext> _parseTreeResults;
15+
16+
public OptionBaseZeroInspection(RubberduckParserState state)
17+
: base(state, CodeInspectionSeverity.Hint)
18+
{
19+
}
20+
21+
public override string Meta { get { return InspectionsUI.OptionBaseZeroInspectionMeta; } }
22+
public override string Description { get { return InspectionsUI.OptionBaseZeroInspectionName; } }
23+
public override CodeInspectionType InspectionType { get { return CodeInspectionType.MaintainabilityAndReadabilityIssues; } }
24+
25+
public IEnumerable<QualifiedContext<VBAParser.OptionBaseStmtContext>> ParseTreeResults { get { return _parseTreeResults.OfType<QualifiedContext<VBAParser.OptionBaseStmtContext>>(); } }
26+
public void SetResults(IEnumerable<QualifiedContext> results) { _parseTreeResults = results; }
27+
28+
public override IEnumerable<InspectionResultBase> GetInspectionResults()
29+
{
30+
if (ParseTreeResults == null)
31+
{
32+
return new InspectionResultBase[] { };
33+
}
34+
35+
return ParseTreeResults.Where(context => !IsIgnoringInspectionResultFor(context.ModuleName.Component, context.Context.Start.Line))
36+
.Select(context => new OptionBaseZeroInspectionResult(this, new QualifiedContext<VBAParser.OptionBaseStmtContext>(context.ModuleName, context.Context)));
37+
}
38+
39+
public class OptionBaseStatementListener : VBAParserBaseListener
40+
{
41+
private readonly IList<VBAParser.OptionBaseStmtContext> _contexts = new List<VBAParser.OptionBaseStmtContext>();
42+
public IEnumerable<VBAParser.OptionBaseStmtContext> Contexts { get { return _contexts; } }
43+
44+
public override void ExitOptionBaseStmt(VBAParser.OptionBaseStmtContext context)
45+
{
46+
if (context.numberLiteral()?.INTEGERLITERAL().Symbol.Text == "0")
47+
{
48+
_contexts.Add(context);
49+
}
50+
}
51+
}
52+
}
53+
}

‎RetailCoder.VBE/Inspections/QuickFixes/RemoveOptionBaseStatementQuickFix.cs

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
using Antlr4.Runtime;
2+
using Rubberduck.Inspections.Abstract;
3+
using Rubberduck.Inspections.Resources;
4+
using Rubberduck.VBEditor;
5+
using System;
6+
using System.Linq;
7+
8+
namespace Rubberduck.Inspections.QuickFixes
9+
{
10+
internal class RemoveOptionBaseStatementQuickFix : QuickFixBase
11+
{
12+
public RemoveOptionBaseStatementQuickFix(ParserRuleContext context, QualifiedSelection selection)
13+
: base(context, selection, InspectionsUI.RemoveOptionBaseStatementQuickFix)
14+
{
15+
}
16+
17+
public override void Fix()
18+
{
19+
var module = Selection.QualifiedName.Component.CodeModule;
20+
var lines = module.GetLines(Selection.Selection).Split(new[] { Environment.NewLine }, StringSplitOptions.None);
21+
22+
var newContent = Selection.Selection.LineCount != 1
23+
? lines[0].Remove(Selection.Selection.StartColumn - 1)
24+
: lines[0].Remove(Selection.Selection.StartColumn - 1, Selection.Selection.EndColumn - Selection.Selection.StartColumn);
25+
26+
if (Selection.Selection.LineCount != 1)
27+
{
28+
newContent += lines.Last().Remove(0, Selection.Selection.EndColumn - 1);
29+
}
30+
31+
module.DeleteLines(Selection.Selection);
32+
module.InsertLines(Selection.Selection.StartLine, newContent);
33+
}
34+
}
35+
}

‎RetailCoder.VBE/Inspections/Resources/InspectionsUI.Designer.cs

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

‎RetailCoder.VBE/Inspections/Resources/InspectionsUI.resx

Lines changed: 15 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
<?xml version="1.0" encoding="UTF-8"?>
1+
<?xml version="1.0" encoding="utf-8"?>
22
<root>
33
<!--
44
Microsoft ResX Schema
@@ -59,7 +59,7 @@
5959
: using a System.ComponentModel.TypeConverter
6060
: and then encoded with base64 encoding.
6161
-->
62-
<xsd:schema xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata" id="root">
62+
<xsd:schema id="root" xmlns="" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:msdata="urn:schemas-microsoft-com:xml-msdata">
6363
<xsd:import namespace="http://www.w3.org/XML/1998/namespace" />
6464
<xsd:element name="root" msdata:IsDataSet="true">
6565
<xsd:complexType>
@@ -650,4 +650,16 @@ If the parameter can be null, ignore this inspection result; passing a null valu
650650
<data name="AssignedByValParameterMakeLocalCopyQuickFix" xml:space="preserve">
651651
<value>Create and use a local copy of the parameter</value>
652652
</data>
653-
</root>
653+
<data name="OptionBaseZeroInspectionMeta" xml:space="preserve">
654+
<value>'Option Base 0' is the default base</value>
655+
</data>
656+
<data name="OptionBaseZeroInspectionName" xml:space="preserve">
657+
<value>'Option Base 0' used</value>
658+
</data>
659+
<data name="OptionBaseZeroInspectionResultFormat" xml:space="preserve">
660+
<value>Component '{0} uses 'Option Base 0'</value>
661+
</data>
662+
<data name="RemoveOptionBaseStatementQuickFix" xml:space="preserve">
663+
<value>Remove 'Option Base' statement</value>
664+
</data>
665+
</root>

‎RetailCoder.VBE/Inspections/Results/OptionBaseZeroInspectionResult.cs

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
using System.Collections.Generic;
2+
using Rubberduck.Common;
3+
using Rubberduck.Inspections.Abstract;
4+
using Rubberduck.Inspections.Resources;
5+
using Rubberduck.Parsing;
6+
using Rubberduck.Parsing.Grammar;
7+
using Rubberduck.Inspections.QuickFixes;
8+
9+
namespace Rubberduck.Inspections.Results
10+
{
11+
public class OptionBaseZeroInspectionResult : InspectionResultBase
12+
{
13+
private IEnumerable<QuickFixBase> _quickFixes;
14+
15+
public OptionBaseZeroInspectionResult(IInspection inspection, QualifiedContext<VBAParser.OptionBaseStmtContext> qualifiedContext)
16+
: base(inspection, qualifiedContext.ModuleName, qualifiedContext.Context)
17+
{ }
18+
19+
public override IEnumerable<QuickFixBase> QuickFixes
20+
{
21+
get
22+
{
23+
return _quickFixes ?? (_quickFixes = new QuickFixBase[]
24+
{
25+
new RemoveOptionBaseStatementQuickFix(Context, QualifiedSelection),
26+
new IgnoreOnceQuickFix(Context, QualifiedSelection, Inspection.AnnotationName)
27+
});
28+
}
29+
}
30+
31+
public override string Description
32+
{
33+
get { return string.Format(InspectionsUI.OptionBaseZeroInspectionResultFormat.Captialize(), QualifiedName.ComponentName); }
34+
}
35+
}
36+
}

‎RetailCoder.VBE/Rubberduck.csproj

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -346,6 +346,7 @@
346346
<Compile Include="Inspections\HungarianNotationInspection.cs" />
347347
<Compile Include="Inspections\ImplicitDefaultMemberAssignmentInspection.cs" />
348348
<Compile Include="Inspections\MemberNotOnInterfaceInspection.cs" />
349+
<Compile Include="Inspections\OptionBaseZeroInspection.cs" />
349350
<Compile Include="Inspections\QuickFixes\AddIdentifierToWhiteListQuickFix.cs" />
350351
<Compile Include="Inspections\QuickFixes\ApplicationWorksheetFunctionQuickFix.cs" />
351352
<Compile Include="Inspections\QuickFixes\AssignedByValParameterMakeLocalCopyQuickFix.cs" />
@@ -404,6 +405,8 @@
404405
<Compile Include="Inspections\QuickFixes\SplitMultipleDeclarationsQuickFix.cs" />
405406
<Compile Include="Inspections\QuickFixes\RemoveUnusedDeclarationQuickFix.cs" />
406407
<Compile Include="Inspections\QuickFixes\PassParameterByReferenceQuickFix.cs" />
408+
<Compile Include="Inspections\Results\OptionBaseZeroInspectionResult.cs" />
409+
<Compile Include="Inspections\QuickFixes\RemoveOptionBaseStatementQuickFix.cs" />
407410
<Compile Include="Inspections\UndeclaredVariableInspection.cs" />
408411
<Compile Include="Inspections\Results\UndeclaredVariableInspectionResult.cs" />
409412
<Compile Include="Inspections\QuickFixes\UntypedFunctionUsageQuickFix.cs" />

0 commit comments

Comments
 (0)