[CodeIssue] Added ReferenceEqualsCalledWithValueTypeIssue

ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj

@@ -280,6 +280,7 @@
     <Compile Include="Refactoring\CodeIssues\RedundantElseIssue.cs" />
     <Compile Include="Refactoring\CodeIssues\RedundantFieldInitializerIssue.cs" />
     <Compile Include="Refactoring\CodeIssues\RedundantTypeCastIssue.cs" />
+    <Compile Include="Refactoring\CodeIssues\ReferenceEqualsCalledWithValueTypeIssue.cs" />
     <Compile Include="Refactoring\CodeIssues\UnreachableCodeIssue.cs" />
     <Compile Include="Refactoring\CodeIssues\VariableHidesMemberIssue\LocalVariableHidesMemberIssue.cs" />
     <Compile Include="Refactoring\CodeIssues\VariableHidesMemberIssue\ParameterHidesMemberIssue.cs" />

ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/ReferenceEqualsCalledWithValueTypeIssue.cs

@@ -0,0 +1,74 @@
+// 
+// ReferenceEqualsCalledWithValueTypeIssue.cs
+// 
+// Author:
+//      Mansheng Yang <lightyang0@gmail.com>
+// 
+// Copyright (c) 2012 Mansheng Yang <lightyang0@gmail.com>
+// 
+// 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 System.Linq;
+using ICSharpCode.NRefactory.Semantics;
+using ICSharpCode.NRefactory.TypeSystem;
+
+namespace ICSharpCode.NRefactory.CSharp.Refactoring
+{
+	[IssueDescription ("'Object.ReferenceEquals' is always false because it is called with value type",
+					   Description = "'Object.ReferenceEquals' is always false because it is called with value type.",
+					   Category = IssueCategories.CodeQualityIssues,
+					   Severity = Severity.Warning,
+					   IssueMarker = IssueMarker.Underline)]
+	public class ReferenceEqualsCalledWithValueTypeIssue : ICodeIssueProvider
+	{
+		public IEnumerable<CodeIssue> GetIssues (BaseRefactoringContext context)
+		{
+			return new GatherVisitor (context).GetIssues ();
+		}
+
+		class GatherVisitor : GatherVisitorBase
+		{
+			public GatherVisitor(BaseRefactoringContext ctx)
+				: base (ctx)
+			{
+			}
+
+			public override void VisitInvocationExpression (InvocationExpression invocationExpression)
+			{
+				base.VisitInvocationExpression (invocationExpression);
+
+				var resolveResult = ctx.Resolve (invocationExpression) as InvocationResolveResult;
+				if (resolveResult == null || 
+					resolveResult.Member.DeclaringTypeDefinition == null ||
+					resolveResult.Member.DeclaringTypeDefinition.KnownTypeCode != KnownTypeCode.Object ||
+					resolveResult.Member.Name != "ReferenceEquals" ||
+					invocationExpression.Arguments.All(arg => ctx.Resolve(arg).Type.IsReferenceType ?? true))
+					return;
+
+				var action = new CodeAction (ctx.TranslateString ("Use Equals()"),
+					script => script.Replace (invocationExpression.Target, new MemberReferenceExpression (
+						new TypeReferenceExpression (new PrimitiveType ("object")), "Equals")));
+				AddIssue (invocationExpression,
+					ctx.TranslateString ("'Object.ReferenceEquals' is always false because it is called with value type"),
+					new [] { action });
+			}
+		}
+	}
+}

ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/ReferenceEqualsCalledWithValueTypeIssueTest.cs

@@ -0,0 +1,74 @@
+// 
+// ReferenceEqualsCalledWithValueTypeIssueTest.cs
+// 
+// Author:
+//      Mansheng Yang <lightyang0@gmail.com>
+// 
+// Copyright (c) 2012 Mansheng Yang <lightyang0@gmail.com>
+// 
+// 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 ICSharpCode.NRefactory.CSharp.Refactoring;
+using NUnit.Framework;
+
+namespace ICSharpCode.NRefactory.CSharp.CodeIssues
+{
+	[TestFixture]
+	public class ReferenceEqualsCalledWithValueTypeIssueTest : InspectionActionTestBase
+	{
+		[Test]
+		public void TestValueType ()
+		{
+			var input = @"
+class TestClass
+{
+	void TestMethod (int i, int j)
+	{
+		var x = object.ReferenceEquals (i, j);
+		var x2 = ReferenceEquals (i, j);
+	}
+}";
+			var output = @"
+class TestClass
+{
+	void TestMethod (int i, int j)
+	{
+		var x = object.Equals (i, j);
+		var x2 = object.Equals (i, j);
+	}
+}";
+			Test<ReferenceEqualsCalledWithValueTypeIssue> (input, 2, output);
+		}
+
+		[Test]
+		public void TestNoIssue ()
+		{
+			var input = @"
+class TestClass
+{
+	void TestMethod<T> (object i, T j)
+	{
+		var x = object.ReferenceEquals (i, i);
+		var x2 = object.ReferenceEquals (j, j);
+	}
+}";
+			Test<ReferenceEqualsCalledWithValueTypeIssue> (input, 0);
+		}
+	}
+}

ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj

@@ -125,6 +125,7 @@
     <Compile Include="CSharp\CodeIssues\RedundantElseIssueTests.cs" />
     <Compile Include="CSharp\CodeIssues\RedundantFieldInitializerIssueTests.cs" />
     <Compile Include="CSharp\CodeIssues\RedundantTypeCastIssueTests.cs" />
+    <Compile Include="CSharp\CodeIssues\ReferenceEqualsCalledWithValueTypeIssueTest.cs" />
     <Compile Include="CSharp\CodeIssues\TypeParameterNotUsedIssueTests.cs" />
     <Compile Include="CSharp\CodeIssues\UnreachableCodeIssueTests.cs" />
     <Compile Include="CSharp\CSharpAmbienceTests.cs" />