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

« back to all changes in this revision

Viewing changes to external/nrefactory/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/ReferenceToStaticMemberViaDerivedTypeIssue.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:
 
1
//
 
2
// CallToStaticMemberViaDerivedTypeIssue.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.Collections.Generic;
 
27
using ICSharpCode.NRefactory.Semantics;
 
28
using ICSharpCode.NRefactory.TypeSystem;
 
29
 
 
30
namespace ICSharpCode.NRefactory.CSharp.Refactoring
 
31
{
 
32
        [IssueDescription("Call to static member via a derived class",
 
33
                           Description = "Suggests using the class declaring a static function when calling it.",
 
34
                           Category = IssueCategories.CodeQualityIssues,
 
35
                           Severity = Severity.Suggestion,
 
36
                       ResharperDisableKeyword = "AccessToStaticMemberViaDerivedType")]
 
37
        public class ReferenceToStaticMemberViaDerivedTypeIssue : ICodeIssueProvider
 
38
        {
 
39
                #region ICodeIssueProvider implementation
 
40
                public IEnumerable<CodeIssue> GetIssues(BaseRefactoringContext context)
 
41
                {
 
42
                        return new GatherVisitor(context).GetIssues();
 
43
                }
 
44
 
 
45
                class GatherVisitor : GatherVisitorBase<ReferenceToStaticMemberViaDerivedTypeIssue>
 
46
                {
 
47
                        readonly BaseRefactoringContext context;
 
48
                        
 
49
                        public GatherVisitor(BaseRefactoringContext context) : base (context)
 
50
                        {
 
51
                                this.context = context;
 
52
                        }
 
53
 
 
54
                        public override void VisitMemberReferenceExpression(MemberReferenceExpression memberReferenceExpression)
 
55
                        {
 
56
                                base.VisitMemberReferenceExpression(memberReferenceExpression);
 
57
                                if (memberReferenceExpression == null || memberReferenceExpression.Target is ThisReferenceExpression)
 
58
                                        // Call within current class scope using 'this' or 'base'
 
59
                                        return;
 
60
                                var memberResolveResult = context.Resolve(memberReferenceExpression) as MemberResolveResult;
 
61
                                if (memberResolveResult == null)
 
62
                                        return;
 
63
                                if (!memberResolveResult.Member.IsStatic)
 
64
                                        return;
 
65
                                HandleMember(memberReferenceExpression, memberReferenceExpression.Target, memberResolveResult.Member, memberResolveResult.TargetResult);
 
66
                        }
 
67
                        
 
68
                        public override void VisitInvocationExpression(InvocationExpression invocationExpression)
 
69
                        {
 
70
                                base.VisitInvocationExpression(invocationExpression);
 
71
                                if (invocationExpression.Target is IdentifierExpression)
 
72
                                        // Call within current class scope without 'this' or 'base'
 
73
                                        return;
 
74
                                var memberReference = invocationExpression.Target as MemberReferenceExpression;
 
75
                                if (memberReference == null || memberReference.Target is ThisReferenceExpression)
 
76
                                        // Call within current class scope using 'this' or 'base'
 
77
                                        return;
 
78
                                var invocationResolveResult = context.Resolve(invocationExpression) as InvocationResolveResult;
 
79
                                if (invocationResolveResult == null)
 
80
                                        return;
 
81
                                HandleMember(invocationExpression, memberReference.Target, invocationResolveResult.Member, invocationResolveResult.TargetResult);
 
82
                        }
 
83
 
 
84
                        void HandleMember(Expression issueAnchor, Expression targetExpression, IMember member, ResolveResult targetResolveResult)
 
85
                        {
 
86
                                var typeResolveResult = targetResolveResult as TypeResolveResult;
 
87
                                if (typeResolveResult == null)
 
88
                                        return;
 
89
                                if (!member.IsStatic)
 
90
                                        return;
 
91
                                if (typeResolveResult.Type.Equals(member.DeclaringType))
 
92
                                        return;
 
93
                                // check whether member.DeclaringType contains the original type
 
94
                                // (curiously recurring template pattern)
 
95
                                var v = new ContainsTypeVisitor(typeResolveResult.Type.GetDefinition());
 
96
                                member.DeclaringType.AcceptVisitor(v);
 
97
                                if (v.IsContained)
 
98
                                        return;
 
99
                                AddIssue(issueAnchor, context.TranslateString("Static method invoked via derived type"),
 
100
                                         GetAction(context, targetExpression, member));
 
101
                        }
 
102
 
 
103
                        CodeAction GetAction(BaseRefactoringContext context, Expression targetExpression,
 
104
                                                           IMember member)
 
105
                        {
 
106
                                var builder = context.CreateTypeSytemAstBuilder(targetExpression);
 
107
                                var newType = builder.ConvertType(member.DeclaringType);
 
108
                                string description = string.Format("{0} '{1}'", context.TranslateString("Use base class"), newType.GetText());
 
109
                                return new CodeAction(description, script => {
 
110
                                        script.Replace(targetExpression, newType);
 
111
                                }, targetExpression);
 
112
                        }
 
113
                        
 
114
                        sealed class ContainsTypeVisitor : TypeVisitor
 
115
                        {
 
116
                                readonly ITypeDefinition searchedType;
 
117
                                internal bool IsContained;
 
118
                                
 
119
                                public ContainsTypeVisitor(ITypeDefinition searchedType)
 
120
                                {
 
121
                                        this.searchedType = searchedType;
 
122
                                }
 
123
                                
 
124
                                public override IType VisitTypeDefinition(ITypeDefinition type)
 
125
                                {
 
126
                                        if (type.Equals(searchedType))
 
127
                                                IsContained = true;
 
128
                                        return base.VisitTypeDefinition(type);
 
129
                                }
 
130
                        }
 
131
                }
 
132
                #endregion
 
133
        }
 
134
}
 
135