← 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/VariableNotUsedIssues/ParameterNotUsedIssue.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/VariableNotUsedIssues/ParameterNotUsedIssue.cs
 
1
// 
 
2
// ParameterNotUsedIssue.cs
 
3
// 
 
4
// Author:
 
5
//      Mansheng Yang <lightyang0@gmail.com>
 
6
// 
 
7
// Copyright (c) 2012 Mansheng Yang <lightyang0@gmail.com>
 
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
 
 
27
using ICSharpCode.NRefactory.Semantics;
 
28
using System.Linq;
 
29
using ICSharpCode.NRefactory.TypeSystem;
 
30
using System.Collections.Generic;
 
31
using ICSharpCode.NRefactory.CSharp.Resolver;
 
32
using System;
 
33
 
 
34
namespace ICSharpCode.NRefactory.CSharp.Refactoring
 
35
{
 
36
        [IssueDescription ("Unused parameter",
 
37
                           Description = "Parameter is never used.",
 
38
                           Category = IssueCategories.Redundancies,
 
39
                           Severity = Severity.Warning,
 
40
                           IssueMarker = IssueMarker.GrayOut)]
 
41
        public class ParameterNotUsedIssue : ICodeIssueProvider
 
42
        {
 
43
                #region ICodeIssueProvider implementation
 
44
                public IEnumerable<CodeIssue> GetIssues(BaseRefactoringContext context)
 
45
                {
 
46
                        var delegateVisitor = new GetDelgateUsagesVisitor (context);
 
47
                        context.RootNode.AcceptVisitor (delegateVisitor);
 
48
 
 
49
                        return new GatherVisitor (context, delegateVisitor).GetIssues ();
 
50
                }
 
51
                #endregion
 
52
 
 
53
                // Collect all methods that are used as delegate
 
54
                class GetDelgateUsagesVisitor : DepthFirstAstVisitor
 
55
                {
 
56
                        BaseRefactoringContext ctx;
 
57
                        public readonly List<IMethod> UsedMethods = new List<IMethod> ();
 
58
 
 
59
                        public GetDelgateUsagesVisitor(BaseRefactoringContext ctx)
 
60
                        {
 
61
                                this.ctx = ctx;
 
62
                        }
 
63
                        
 
64
                        public override void VisitIdentifierExpression(IdentifierExpression identifierExpression)
 
65
                        {
 
66
                                if (!IsTargetOfInvocation(identifierExpression)) {
 
67
                                        var mgr = ctx.Resolve (identifierExpression) as MethodGroupResolveResult;
 
68
                                        if (mgr != null)
 
69
                                                UsedMethods.AddRange (mgr.Methods);
 
70
                                }
 
71
                                base.VisitIdentifierExpression(identifierExpression);
 
72
                        }
 
73
 
 
74
                        public override void VisitMemberReferenceExpression(MemberReferenceExpression memberReferenceExpression)
 
75
                        {
 
76
                                if (!IsTargetOfInvocation(memberReferenceExpression)) {
 
77
                                        var mgr = ctx.Resolve (memberReferenceExpression) as MethodGroupResolveResult;
 
78
                                        if (mgr != null)
 
79
                                                UsedMethods.AddRange (mgr.Methods);
 
80
                                }
 
81
                                base.VisitMemberReferenceExpression(memberReferenceExpression);
 
82
                        }
 
83
                        
 
84
                        static bool IsTargetOfInvocation(AstNode node)
 
85
                        {
 
86
                                return node.Role == Roles.TargetExpression && node.Parent is InvocationExpression;
 
87
                        }
 
88
                }
 
89
 
 
90
                class GatherVisitor : GatherVisitorBase<ParameterNotUsedIssue>
 
91
                {
 
92
                        GetDelgateUsagesVisitor usedDelegates;
 
93
                        bool currentTypeIsPartial;
 
94
                        
 
95
                        public GatherVisitor (BaseRefactoringContext ctx, GetDelgateUsagesVisitor usedDelegates)
 
96
                                : base (ctx)
 
97
                        {
 
98
                                this.usedDelegates = usedDelegates;
 
99
                        }
 
100
                        
 
101
                        public override void VisitTypeDeclaration(TypeDeclaration typeDeclaration)
 
102
                        {
 
103
                                bool outerTypeIsPartial = currentTypeIsPartial;
 
104
                                currentTypeIsPartial = typeDeclaration.HasModifier(Modifiers.Partial);
 
105
                                base.VisitTypeDeclaration(typeDeclaration);
 
106
                                currentTypeIsPartial = outerTypeIsPartial;
 
107
                        }
 
108
 
 
109
                        public override void VisitMethodDeclaration(MethodDeclaration methodDeclaration)
 
110
                        {
 
111
                                // Only some methods are candidates for the warning
 
112
 
 
113
                                if (methodDeclaration.Body.IsNull)
 
114
                                        return;
 
115
                                if (methodDeclaration.Modifiers.HasFlag (Modifiers.Virtual) || 
 
116
                                    methodDeclaration.Modifiers.HasFlag (Modifiers.New) ||
 
117
                                    methodDeclaration.Modifiers.HasFlag (Modifiers.Partial))
 
118
                                        return;
 
119
                                var methodResolveResult = ctx.Resolve(methodDeclaration) as MemberResolveResult;
 
120
                                if (methodResolveResult == null)
 
121
                                        return;
 
122
                                var member = methodResolveResult.Member;
 
123
                                if (member.IsOverride)
 
124
                                        return;
 
125
                                if (member.ImplementedInterfaceMembers.Any ())
 
126
                                        return;
 
127
                                if (usedDelegates.UsedMethods.Any (m => m.MemberDefinition == member))
 
128
                                        return;
 
129
                                if (currentTypeIsPartial && methodDeclaration.Parameters.Count == 2) {
 
130
                                        if (methodDeclaration.Parameters.First().Name == "sender") {
 
131
                                                // Looks like an event handler; the registration might be in the designer part
 
132
                                                return;
 
133
                                        }
 
134
                                }
 
135
                                foreach (var parameter in methodDeclaration.Parameters)
 
136
                                        parameter.AcceptVisitor (this);
 
137
                        }
 
138
 
 
139
                        public override void VisitParameterDeclaration (ParameterDeclaration parameterDeclaration)
 
140
                        {
 
141
                                base.VisitParameterDeclaration (parameterDeclaration);
 
142
 
 
143
                                if (!(parameterDeclaration.Parent is MethodDeclaration || parameterDeclaration.Parent is ConstructorDeclaration))
 
144
                                        return;
 
145
 
 
146
                                var resolveResult = ctx.Resolve (parameterDeclaration) as LocalResolveResult;
 
147
                                if (resolveResult == null)
 
148
                                        return;
 
149
 
 
150
                                if (ctx.FindReferences (parameterDeclaration.Parent, resolveResult.Variable).Any(r => r.Node != parameterDeclaration))
 
151
                                        return;
 
152
 
 
153
                                AddIssue (parameterDeclaration.NameToken, ctx.TranslateString ("Parameter is never used"));
 
154
                        }
 
155
                }
 
156
        }
 
157
}