/
ChangeIntegerToLongQuickFix.cs
216 lines (193 loc) · 10.2 KB
/
ChangeIntegerToLongQuickFix.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
using System;
using System.Linq;
using Antlr4.Runtime;
using Rubberduck.CodeAnalysis.Inspections;
using Rubberduck.CodeAnalysis.Inspections.Concrete;
using Rubberduck.CodeAnalysis.QuickFixes.Abstract;
using Rubberduck.JunkDrawer.Extensions;
using Rubberduck.Parsing;
using Rubberduck.Parsing.Grammar;
using Rubberduck.Parsing.Rewriter;
using Rubberduck.Parsing.Symbols;
using Rubberduck.Parsing.VBA;
namespace Rubberduck.CodeAnalysis.QuickFixes.Concrete
{
/// <summary>
/// Changes 16-bit (max value 32,767) Integer declarations to use 32-bit (max value 2,147,483,647) Long integer type instead.
/// </summary>
/// <inspections>
/// <inspection name="IntegerDataTypeInspection" />
/// </inspections>
/// <canfix multiple="true" procedure="true" module="true" project="true" all="true" />
/// <example>
/// <before>
/// <![CDATA[
/// Public Sub DoSomething()
/// Dim row As Integer
/// row = Sheet1.Range("A" & Sheet1.Rows.Count).End(xlUp).Row
/// Debug.Print row
/// End Sub
/// ]]>
/// </before>
/// <after>
/// <![CDATA[
/// Public Sub DoSomething()
/// Dim row As Long
/// row = Sheet1.Range("A" & Sheet1.Rows.Count).End(xlUp).Row
/// Debug.Print row
/// End Sub
/// ]]>
/// </after>
/// </example>
internal sealed class ChangeIntegerToLongQuickFix : QuickFixBase
{
private readonly IDeclarationFinderProvider _declarationFinderProvider;
public ChangeIntegerToLongQuickFix(IDeclarationFinderProvider declarationFinderProvider)
: base(typeof(IntegerDataTypeInspection))
{
_declarationFinderProvider = declarationFinderProvider;
}
public override void Fix(IInspectionResult result, IRewriteSession rewriteSession)
{
var rewriter = rewriteSession.CheckOutModuleRewriter(result.Target.QualifiedModuleName);
if (result.Target.HasTypeHint)
{
ReplaceTypeHint(result.Context, rewriter);
}
else
{
switch (result.Target.DeclarationType)
{
case DeclarationType.Variable:
var variableContext = (VBAParser.VariableSubStmtContext)result.Context;
rewriter.Replace(variableContext.asTypeClause().type(), Tokens.Long);
break;
case DeclarationType.Constant:
var constantContext = (VBAParser.ConstSubStmtContext)result.Context;
rewriter.Replace(constantContext.asTypeClause().type(), Tokens.Long);
break;
case DeclarationType.Parameter:
var parameterContext = (VBAParser.ArgContext)result.Context;
rewriter.Replace(parameterContext.asTypeClause().type(), Tokens.Long);
break;
case DeclarationType.Function:
var functionContext = (VBAParser.FunctionStmtContext)result.Context;
rewriter.Replace(functionContext.asTypeClause().type(), Tokens.Long);
break;
case DeclarationType.PropertyGet:
var propertyContext = (VBAParser.PropertyGetStmtContext)result.Context;
rewriter.Replace(propertyContext.asTypeClause().type(), Tokens.Long);
break;
case DeclarationType.UserDefinedTypeMember:
var userDefinedTypeMemberContext = (VBAParser.UdtMemberContext)result.Context;
rewriter.Replace(
userDefinedTypeMemberContext.reservedNameMemberDeclaration() == null
? userDefinedTypeMemberContext.untypedNameMemberDeclaration().optionalArrayClause().asTypeClause().type()
: userDefinedTypeMemberContext.reservedNameMemberDeclaration().asTypeClause().type(),
Tokens.Long);
break;
}
}
var interfaceMembers = _declarationFinderProvider.DeclarationFinder.FindAllInterfaceMembers().ToArray();
ParserRuleContext matchingInterfaceMemberContext;
switch (result.Target.DeclarationType)
{
case DeclarationType.Parameter:
matchingInterfaceMemberContext = interfaceMembers.Select(member => member.Context).FirstOrDefault(c => c == result.Context.Parent.Parent);
if (matchingInterfaceMemberContext != null)
{
var interfaceParameterIndex = GetParameterIndex((VBAParser.ArgContext)result.Context);
var implementationMembers =
_declarationFinderProvider.DeclarationFinder.FindInterfaceImplementationMembers(interfaceMembers.First(
member => member.Context == matchingInterfaceMemberContext)).ToHashSet();
var parameterDeclarations =
_declarationFinderProvider.DeclarationFinder.UserDeclarations(DeclarationType.Parameter)
.Where(p => implementationMembers.Contains(p.ParentDeclaration))
.Cast<ParameterDeclaration>()
.ToArray();
foreach (var parameter in parameterDeclarations)
{
var parameterContext = (VBAParser.ArgContext)parameter.Context;
var parameterIndex = GetParameterIndex(parameterContext);
if (parameterIndex == interfaceParameterIndex)
{
var parameterRewriter = rewriteSession.CheckOutModuleRewriter(parameter.QualifiedModuleName);
if (parameter.HasTypeHint)
{
ReplaceTypeHint(parameterContext, parameterRewriter);
}
else
{
parameterRewriter.Replace(parameterContext.asTypeClause().type(), Tokens.Long);
}
}
}
}
break;
case DeclarationType.Function:
matchingInterfaceMemberContext = interfaceMembers.Select(member => member.Context).FirstOrDefault(c => c == result.Context);
if (matchingInterfaceMemberContext != null)
{
var functionDeclarations =
_declarationFinderProvider.DeclarationFinder.FindInterfaceImplementationMembers(
interfaceMembers.First(member => member.Context == matchingInterfaceMemberContext))
.Cast<FunctionDeclaration>()
.ToHashSet();
foreach (var function in functionDeclarations)
{
var functionRewriter = rewriteSession.CheckOutModuleRewriter(function.QualifiedModuleName);
if (function.HasTypeHint)
{
ReplaceTypeHint(function.Context, functionRewriter);
}
else
{
var functionContext = (VBAParser.FunctionStmtContext)function.Context;
functionRewriter.Replace(functionContext.asTypeClause().type(), Tokens.Long);
}
}
}
break;
case DeclarationType.PropertyGet:
matchingInterfaceMemberContext = interfaceMembers.Select(member => member.Context).FirstOrDefault(c => c == result.Context);
if (matchingInterfaceMemberContext != null)
{
var propertyGetDeclarations =
_declarationFinderProvider.DeclarationFinder.FindInterfaceImplementationMembers(
interfaceMembers.First(member => member.Context == matchingInterfaceMemberContext))
.Cast<PropertyGetDeclaration>()
.ToHashSet();
foreach (var propertyGet in propertyGetDeclarations)
{
var propertyGetRewriter = rewriteSession.CheckOutModuleRewriter(propertyGet.QualifiedModuleName);
if (propertyGet.HasTypeHint)
{
ReplaceTypeHint(propertyGet.Context, propertyGetRewriter);
}
else
{
var propertyGetContext = (VBAParser.PropertyGetStmtContext)propertyGet.Context;
propertyGetRewriter.Replace(propertyGetContext.asTypeClause().type(), Tokens.Long);
}
}
}
break;
}
}
public override string Description(IInspectionResult result) => Resources.Inspections.QuickFixes.IntegerDataTypeQuickFix;
public override bool CanFixMultiple => true;
public override bool CanFixInProcedure => true;
public override bool CanFixInModule => true;
public override bool CanFixInProject => true;
public override bool CanFixAll => true;
private static int GetParameterIndex(VBAParser.ArgContext context)
{
return Array.IndexOf(((VBAParser.ArgListContext)context.Parent).arg().ToArray(), context);
}
private static void ReplaceTypeHint(RuleContext context, IModuleRewriter rewriter)
{
var typeHintContext = ((ParserRuleContext)context).GetDescendent<VBAParser.TypeHintContext>();
rewriter.Replace(typeHintContext, "&");
}
}
}