diff --git a/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj b/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj index 71dfe27385..433a2feb8d 100644 --- a/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj +++ b/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj @@ -400,6 +400,7 @@ + diff --git a/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToObjectEqualsViaBaseIssue.cs b/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToObjectEqualsViaBaseIssue.cs new file mode 100644 index 0000000000..2ae97d91ec --- /dev/null +++ b/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToObjectEqualsViaBaseIssue.cs @@ -0,0 +1,97 @@ +// +// CallToObjectEqualsViaBaseIssue.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.Semantics; +using System.Linq; + +namespace ICSharpCode.NRefactory.CSharp.Refactoring +{ + [IssueDescription("Call to base.Equals resolves to Object.Equals, which is reference equality", + Description = "Finds potentially erroneous calls to Object.Equals.", + Category = IssueCategories.CodeQualityIssues, + Severity = Severity.Warning)] + public class CallToObjectEqualsViaBaseIssue : ICodeIssueProvider + { + public IEnumerable GetIssues(BaseRefactoringContext context) + { + return new GatherVisitor(context).GetIssues(); + } + + class GatherVisitor : GatherVisitorBase + { + IType objectType; + + public GatherVisitor(BaseRefactoringContext context) : base (context) + { + objectType = context.Compilation.FindType(KnownTypeCode.Object); + } + + public override void VisitInvocationExpression(InvocationExpression invocationExpression) + { + base.VisitInvocationExpression(invocationExpression); + + if (invocationExpression.Arguments.Count != 1) { + return; + } + var memberReference = invocationExpression.Target as MemberReferenceExpression; + if (memberReference == null) { + return; + } + var targetedObject = memberReference.Target as BaseReferenceExpression; + if (targetedObject == null) { + return; + } + var resolveResult = ctx.Resolve(targetedObject) as ThisResolveResult; + if (resolveResult == null || resolveResult.Type != objectType) { + return; + } + var title = ctx.TranslateString("Call to base.Equals resolves to Object.Equals, which is reference equality"); + AddIssue(invocationExpression, title, GetActions(invocationExpression)); + } + + IEnumerable GetActions(InvocationExpression invocationExpression) + { + yield return new CodeAction(ctx.TranslateString("Change invocation to call Object.ReferenceEquals"), script => { + var args = Enumerable.Concat(new [] { new ThisReferenceExpression() }, invocationExpression.Arguments.Select(arg => arg.Clone())); + var newInvocation = MakeInvocation("object.ReferenceEquals", args); + script.Replace(invocationExpression, newInvocation); + }); + yield return new CodeAction(ctx.TranslateString("Remove 'base.'"), script => { + var newInvocation = MakeInvocation("Equals", invocationExpression.Arguments.Select(arg => arg.Clone())); + script.Replace(invocationExpression, newInvocation); + }); + } + + static InvocationExpression MakeInvocation(string memberName, IEnumerable unClonedArguments) + { + return new InvocationExpression(new IdentifierExpression(memberName), unClonedArguments); + } + } + } +} + diff --git a/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/CallToObjectEqualsViaBaseTests.cs b/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/CallToObjectEqualsViaBaseTests.cs new file mode 100644 index 0000000000..15d4f0634f --- /dev/null +++ b/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/CallToObjectEqualsViaBaseTests.cs @@ -0,0 +1,63 @@ +// +// CallToObjectEqualsViaBaseTests.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 CallToObjectEqualsViaBaseTests : InspectionActionTestBase + { + + [Test] + public void SimpleCase() + { + var input = @" +class Foo +{ + Foo() + { + bool b = base.Equals (""blah""); + } +}"; + TestRefactoringContext context; + var issues = GetIssues(new CallToObjectEqualsViaBaseIssue(), input, out context); + Assert.AreEqual(1, issues.Count); + + CheckFix(context, issues, @" +class Foo +{ + Foo() + { + bool b = object.ReferenceEquals (this, ""blah""); + } +}"); + } + } +} + diff --git a/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj b/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj index abcc9b09c0..028ee1358f 100644 --- a/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj +++ b/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj @@ -295,6 +295,7 @@ +