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
|
//
// ParameterCanBeIEnumerableIssue.cs
//
// Author:
// Ciprian Khlud <ciprian.mustiata@yahoo.com>
//
// Copyright (c) 2013 Ciprian Khlud
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using System.Collections.Generic;
using ICSharpCode.NRefactory.TypeSystem;
using ICSharpCode.NRefactory.Semantics;
using System.Linq;
namespace ICSharpCode.NRefactory.CSharp.Refactoring
{
// Does this even make sense ? We've a parameter can be demoted issue which does mostly the same.
// [IssueDescription("A parameter can IEnumerable/ICollection/IList<T>",
// Description = "Finds parameters that can be demoted to a generic list.",
// Category = IssueCategories.Opportunities,
// Severity = Severity.Suggestion
// )]
public class ParameterCanBeIEnumerableIssue : ICodeIssueProvider
{
readonly bool tryResolve;
public ParameterCanBeIEnumerableIssue() : this (true)
{
}
public ParameterCanBeIEnumerableIssue(bool tryResolve)
{
this.tryResolve = tryResolve;
}
#region ICodeIssueProvider implementation
public IEnumerable<CodeIssue> GetIssues(BaseRefactoringContext context)
{
var gatherer = new GatherVisitor(context, tryResolve);
var issues = gatherer.GetIssues();
return issues;
}
#endregion
class GatherVisitor : GatherVisitorBase<ParameterCanBeIEnumerableIssue>
{
bool tryResolve;
public GatherVisitor(BaseRefactoringContext context, bool tryResolve) : base (context)
{
this.tryResolve = tryResolve;
}
public override void VisitMethodDeclaration(MethodDeclaration methodDeclaration)
{
methodDeclaration.Attributes.AcceptVisitor(this);
if (HasEntryPointSignature(methodDeclaration))
return;
var eligibleParameters = methodDeclaration.Parameters
.Where(p => p.ParameterModifier != ParameterModifier.Out && p.ParameterModifier != ParameterModifier.Ref)
.ToList();
if (eligibleParameters.Count == 0)
return;
var declarationResolveResult = ctx.Resolve(methodDeclaration) as MemberResolveResult;
if (declarationResolveResult == null)
return;
var member = declarationResolveResult.Member;
if (member.IsOverride || member.IsOverridable || member.ImplementedInterfaceMembers.Any())
return;
var collector = new TypeCriteriaCollector(ctx);
methodDeclaration.AcceptVisitor(collector);
foreach (var parameter in eligibleParameters) {
ProcessParameter(parameter, methodDeclaration.Body, collector);
}
}
bool HasEntryPointSignature(MethodDeclaration methodDeclaration)
{
if (!methodDeclaration.Modifiers.HasFlag(Modifiers.Static))
return false;
var returnType = ctx.Resolve(methodDeclaration.ReturnType).Type;
if (!returnType.IsKnownType(KnownTypeCode.Int32) && !returnType.IsKnownType(KnownTypeCode.Void))
return false;
var parameterCount = methodDeclaration.Parameters.Count;
if (parameterCount == 0)
return true;
if (parameterCount != 1)
return false;
var parameterType = ctx.Resolve(methodDeclaration.Parameters.First()).Type as ArrayType;
return parameterType != null && parameterType.ElementType.IsKnownType(KnownTypeCode.String);
}
void ProcessParameter(ParameterDeclaration parameter, AstNode rootResolutionNode, TypeCriteriaCollector collector)
{
var localResolveResult = ctx.Resolve(parameter) as LocalResolveResult;
if (localResolveResult == null)
return;
var variable = localResolveResult.Variable;
var typeKind = variable.Type.Kind;
if (!(typeKind == TypeKind.Class ||
typeKind == TypeKind.Struct ||
typeKind == TypeKind.Interface ||
typeKind == TypeKind.Array) ||
!collector.UsedVariables.Contains(variable))
{
return;
}
var candidateTypes = localResolveResult.Type.GetAllBaseTypes()
.Where(t => t.IsParameterized)
.ToList();
var validTypes =
(from type in candidateTypes
where !tryResolve || ParameterCanBeDemotedIssue.TypeChangeResolvesCorrectly(ctx, parameter, rootResolutionNode, type)
select type).ToList();
if (!validTypes.Any()) return;
var foundType = validTypes.FirstOrDefault();
if (foundType == null)
return;
AddIssue(parameter.NameToken, string.Format(ctx.TranslateString("Parameter can be {0}"),
foundType.Name),
script => script.Replace(parameter.Type, CreateShortType(ctx, foundType, parameter)));
}
public static AstType CreateShortType(BaseRefactoringContext refactoringContext, IType expressionType, AstNode node)
{
var csResolver = refactoringContext.Resolver.GetResolverStateBefore(node);
var builder = new TypeSystemAstBuilder(csResolver);
return builder.ConvertType(expressionType);
}
}
}
}
|