diff --git a/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj b/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj index b64940453f..71dfe27385 100644 --- a/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj +++ b/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj @@ -399,6 +399,7 @@ + diff --git a/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/RedundantToStringIssue.cs b/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/RedundantToStringIssue.cs new file mode 100644 index 0000000000..2e19e4da90 --- /dev/null +++ b/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/RedundantToStringIssue.cs @@ -0,0 +1,196 @@ +// +// RedundantToStringIssue.cs +// +// Author: +// Simon Lindgren +// +// Copyright (c) 2012 Simon Lindgren +// +// 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; +using System.Collections.Generic; +using ICSharpCode.NRefactory.TypeSystem; +using ICSharpCode.NRefactory.CSharp.Resolver; +using ICSharpCode.NRefactory.Semantics; +using System.Linq; + +namespace ICSharpCode.NRefactory.CSharp.Refactoring +{ + [IssueDescription("Redundant call to ToString()", + Description = "Finds calls to ToString() which would occur anyway.", + Category = IssueCategories.Redundancies, + Severity = Severity.Suggestion, + IssueMarker = IssueMarker.GrayOut)] + public class RedundantToStringIssue : ICodeIssueProvider + { + public IEnumerable GetIssues(BaseRefactoringContext context) + { + return new GatherVisitor(context).GetIssues(); + } + + class GatherVisitor : GatherVisitorBase + { + IType stringType; + + IType objectType; + + static Tuple onlyFirst = Tuple.Create (0, 0); + + static IDictionary, Tuple> membersCallingToString = new Dictionary, Tuple> { + { Tuple.Create("System.IO.TextWriter.Write", 1), onlyFirst }, + { Tuple.Create("System.IO.TextWriter.WriteLine", 1), onlyFirst }, + { Tuple.Create("System.Console.Write", 1), onlyFirst }, + { Tuple.Create("System.Console.WriteLine", 1), onlyFirst } + }; + + public GatherVisitor (BaseRefactoringContext context) : base (context) + { + stringType = context.Compilation.FindType(KnownTypeCode.String); + objectType = context.Compilation.FindType(KnownTypeCode.Object); + } + + HashSet processedNodes = new HashSet(); + + void AddRedundantToStringIssue(MemberReferenceExpression memberExpression, InvocationExpression invocationExpression) + { + if (processedNodes.Contains(invocationExpression)) { + return; + } + processedNodes.Add(invocationExpression); + + AddIssue(memberExpression.DotToken.StartLocation, invocationExpression.RParToken.EndLocation, + ctx.TranslateString("Remove redundant call to ToString()"), script => { + script.Replace(invocationExpression, memberExpression.Target.Clone()); + }); + } + + #region Binary operator + public override void VisitBinaryOperatorExpression(BinaryOperatorExpression binaryOperatorExpression) + { + base.VisitBinaryOperatorExpression(binaryOperatorExpression); + + if (binaryOperatorExpression.Operator != BinaryOperatorType.Add) + return; + + var expressions = FlattenBinaryOperator(binaryOperatorExpression); + + int stringExpressionCount = 0; + foreach (var expression in expressions) { + var resolveResult = ctx.Resolve(expression); + if (resolveResult.Type == stringType) { + stringExpressionCount++; + } + if (stringExpressionCount > 1) { + break; + } + } + if (stringExpressionCount <= 1) { + return; + } + + foreach (var expression in expressions) { + CheckExpressionInAutoCallContext(expression); + } + } + + IList FlattenBinaryOperator(BinaryOperatorExpression binaryOperatorExpression) + { + var expressions = new List(); + FlattenBinaryOperator(binaryOperatorExpression, expressions); + return expressions; + } + + void FlattenBinaryOperator(BinaryOperatorExpression binaryOperatorExpression, IList expressions) + { + FlattenExpression(binaryOperatorExpression.Left, expressions); + FlattenExpression(binaryOperatorExpression.Right, expressions); + } + + void FlattenExpression(Expression expression, IList expressions) + { + if (expression is BinaryOperatorExpression) { + FlattenBinaryOperator((BinaryOperatorExpression)expression, expressions); + } + else { + expressions.Add(expression); + } + } + + void CheckExpressionInAutoCallContext(Expression expression) + { + if (expression is InvocationExpression) { + CheckInvocationInAutoCallContext((InvocationExpression)expression); + } + } + + void CheckInvocationInAutoCallContext(InvocationExpression invocationExpression) + { + var memberExpression = invocationExpression.Target as MemberReferenceExpression; + if (memberExpression == null) { + return; + } + var resolveResult = ctx.Resolve(invocationExpression) as CSharpInvocationResolveResult; + if (resolveResult == null) { + return; + } + if (resolveResult.Member.Name != "ToString") { + return; + } + AddRedundantToStringIssue(memberExpression, invocationExpression); + } + #endregion + + #region Invocation expressions + public override void VisitInvocationExpression(InvocationExpression invocationExpression) + { + base.VisitInvocationExpression(invocationExpression); + + var memberExpression = invocationExpression.Target as MemberReferenceExpression; + if (memberExpression == null) { + return; + } + var targetResolveResult = ctx.Resolve(invocationExpression) as CSharpInvocationResolveResult; + if (targetResolveResult == null) { + return; + } + if (targetResolveResult.TargetResult.Type == stringType && targetResolveResult.Member.Name == "ToString") { + AddRedundantToStringIssue(memberExpression, invocationExpression); + } + IMember member = targetResolveResult.Member; + if (member.IsOverride) { + member = InheritanceHelper.GetBaseMember(member); + if (member == null) { + return; + } + } + var key = new Tuple(member.ReflectionName, invocationExpression.Arguments.Count); + Tuple checkInfo; + if (!membersCallingToString.TryGetValue(key, out checkInfo)) { + return; + } + var arguments = invocationExpression.Arguments.ToList(); + for (int i = checkInfo.Item1; i < Math.Min(invocationExpression.Arguments.Count, checkInfo.Item2 + 1); ++i) { + CheckExpressionInAutoCallContext(arguments[i]); + } + } + #endregion + } + } +} + diff --git a/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/RedundantToStringTests.cs b/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/RedundantToStringTests.cs new file mode 100644 index 0000000000..7e346ce789 --- /dev/null +++ b/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/RedundantToStringTests.cs @@ -0,0 +1,136 @@ +// +// RedundantToStringTests.cs +// +// Author: +// Simon Lindgren +// +// Copyright (c) 2012 Simon Lindgren +// +// 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; +using NUnit.Framework; +using ICSharpCode.NRefactory.CSharp.CodeActions; +using ICSharpCode.NRefactory.CSharp.Refactoring; + +namespace ICSharpCode.NRefactory.CSharp.CodeIssues +{ + [TestFixture] + public class RedundantToStringTests : InspectionActionTestBase + { + + [Test] + public void ConcatenationOperator () + { + var input = @" +class Foo +{ + void Bar (int i) + { + string s = """" + i.ToString() + """" + i.ToString(); + } +}"; + + TestRefactoringContext context; + var issues = GetIssues (new RedundantToStringIssue (), input, out context); + Assert.AreEqual (2, issues.Count); + CheckFix (context, issues, @" +class Foo +{ + void Bar (int i) + { + string s = """" + i + """" + i; + } +}"); + } + + [Test] + public void ConcatenationOperatorWithToStringAsOnlyString () + { + var input = @" +class Foo +{ + void Bar (int i) + { + string s = i.ToString() + i + i + i + 1.3; + } +}"; + + TestRefactoringContext context; + var issues = GetIssues (new RedundantToStringIssue (), input, out context); + Assert.AreEqual (0, issues.Count); + } + + [Test] + public void StringTarget () + { + var input = @" +class Foo +{ + void Bar (string str) + { + string s = str.ToString(); + string inOperator = """" + str.ToString(); + } +}"; + + TestRefactoringContext context; + var issues = GetIssues (new RedundantToStringIssue (), input, out context); + Assert.AreEqual (2, issues.Count); + CheckFix (context, issues, @" +class Foo +{ + void Bar (string str) + { + string s = str; + string inOperator = """" + str; + } +}"); + } + + [Test] + public void DetectsBlacklistedCalls () + { + var input = @" +class Foo +{ + void Bar (int i) + { + var w = new System.IO.StringWriter(); + w.Write(i.ToString()); + w.WriteLine(i.ToString()); + } +}"; + + TestRefactoringContext context; + var issues = GetIssues (new RedundantToStringIssue (), input, out context); + Assert.AreEqual (2, issues.Count); + CheckFix (context, issues, @" +class Foo +{ + void Bar (int i) + { + var w = new System.IO.StringWriter(); + w.Write(i); + w.WriteLine(i); + } +}"); + } + } +} + diff --git a/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj b/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj index dc374f17b3..abcc9b09c0 100644 --- a/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj +++ b/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj @@ -294,6 +294,7 @@ +