← Back to branch summary

~ubuntu-branches/ubuntu/trusty/monodevelop/trusty-proposed

« back to all changes in this revision

Viewing changes to external/nrefactory/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToObjectEqualsViaBaseIssue.cs

  • Committer: Package Import Robot
  • Author(s): Jo Shields
  • Date: 2013-05-12 09:46:03 UTC
  • mto: This revision was merged to the branch mainline in revision 29.
  • Revision ID: package-import@ubuntu.com-20130512094603-mad323bzcxvmcam0
Tags: upstream-4.0.5+dfsg
Import upstream version 4.0.5+dfsg

Show diffs side-by-side

added added

removed removed

Lines of Context:
external/nrefactory/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToObjectEqualsViaBaseIssue.cs
 
1
//
 
2
// CallToObjectEqualsViaBaseIssue.cs
 
3
//
 
4
// Author:
 
5
//       Simon Lindgren <simon.n.lindgren@gmail.com>
 
6
//
 
7
// Copyright (c) 2012 Simon Lindgren
 
8
//
 
9
// Permission is hereby granted, free of charge, to any person obtaining a copy
 
10
// of this software and associated documentation files (the "Software"), to deal
 
11
// in the Software without restriction, including without limitation the rights
 
12
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 
13
// copies of the Software, and to permit persons to whom the Software is
 
14
// furnished to do so, subject to the following conditions:
 
15
//
 
16
// The above copyright notice and this permission notice shall be included in
 
17
// all copies or substantial portions of the Software.
 
18
//
 
19
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 
20
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 
21
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 
22
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 
23
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 
24
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 
25
// THE SOFTWARE.
 
26
using System;
 
27
using System.Collections.Generic;
 
28
using ICSharpCode.NRefactory.TypeSystem;
 
29
using ICSharpCode.NRefactory.Semantics;
 
30
using System.Linq;
 
31
 
 
32
namespace ICSharpCode.NRefactory.CSharp.Refactoring
 
33
{
 
34
        [IssueDescription("Call to base.Equals resolves to Object.Equals, which is reference equality",
 
35
                          Description = "Finds potentially erroneous calls to Object.Equals.",
 
36
                          Category = IssueCategories.CodeQualityIssues,
 
37
                          Severity = Severity.Warning,
 
38
                      ResharperDisableKeyword = "BaseObjectEqualsIsObjectEquals")]
 
39
        public class CallToObjectEqualsViaBaseIssue : ICodeIssueProvider
 
40
        {
 
41
                public IEnumerable<CodeIssue> GetIssues(BaseRefactoringContext context)
 
42
                {
 
43
                        return new GatherVisitor(context).GetIssues();
 
44
                }
 
45
                
 
46
                class GatherVisitor : GatherVisitorBase<CallToObjectEqualsViaBaseIssue>
 
47
                {
 
48
                        public GatherVisitor(BaseRefactoringContext context) : base (context)
 
49
                        {
 
50
                        }
 
51
 
 
52
                        public override void VisitInvocationExpression(InvocationExpression invocationExpression)
 
53
                        {
 
54
                                base.VisitInvocationExpression(invocationExpression);
 
55
 
 
56
                                if (invocationExpression.Arguments.Count != 1) {
 
57
                                        return;
 
58
                                }
 
59
                                var memberExpression = invocationExpression.Target as MemberReferenceExpression;
 
60
                                if (memberExpression == null || memberExpression.MemberName != "Equals" || !(memberExpression.Target is BaseReferenceExpression)) {
 
61
                                        return;
 
62
                                }
 
63
                                var resolveResult = ctx.Resolve(invocationExpression) as InvocationResolveResult;
 
64
                                if (resolveResult == null || !resolveResult.Member.DeclaringTypeDefinition.IsKnownType(KnownTypeCode.Object)) {
 
65
                                        return;
 
66
                                }
 
67
                                var title = ctx.TranslateString("Call to base.Equals resolves to Object.Equals, which is reference equality");
 
68
                                AddIssue(invocationExpression, title, GetActions(invocationExpression));
 
69
                        }
 
70
 
 
71
                        IEnumerable<CodeAction> GetActions(InvocationExpression invocationExpression)
 
72
                        {
 
73
                                yield return new CodeAction(ctx.TranslateString("Change invocation to call Object.ReferenceEquals"), script => {
 
74
                                        var args = Enumerable.Concat(new [] { new ThisReferenceExpression() }, invocationExpression.Arguments.Select(arg => arg.Clone()));
 
75
                                        var newInvocation = MakeInvocation("object.ReferenceEquals", args);
 
76
                                        script.Replace(invocationExpression, newInvocation);
 
77
                                }, invocationExpression);
 
78
                                yield return new CodeAction(ctx.TranslateString("Remove 'base.'"), script => {
 
79
                                        var newInvocation = MakeInvocation("Equals", invocationExpression.Arguments.Select(arg => arg.Clone()));
 
80
                                        script.Replace(invocationExpression, newInvocation);
 
81
                                }, invocationExpression);
 
82
                        }
 
83
 
 
84
                        static InvocationExpression MakeInvocation(string memberName, IEnumerable<Expression> unClonedArguments)
 
85
                        {
 
86
                                return new InvocationExpression(new IdentifierExpression(memberName), unClonedArguments);
 
87
                        }
 
88
                }
 
89
        }
 
90
}
 
91