← 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/LocalVariableNotUsedIssue.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/LocalVariableNotUsedIssue.cs
 
1
// 
 
2
// LocalVariableNotUsedIssue.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
 
 
31
namespace ICSharpCode.NRefactory.CSharp.Refactoring
 
32
{
 
33
        [IssueDescription ("Unused local variable",
 
34
                                           Description = "Local variable is never used.",
 
35
                                           Category = IssueCategories.Redundancies,
 
36
                                           Severity = Severity.Warning,
 
37
                                           IssueMarker = IssueMarker.GrayOut)]
 
38
        public class LocalVariableNotUsedIssue : ICodeIssueProvider
 
39
        {
 
40
                #region ICodeIssueProvider implementation
 
41
 
 
42
                public System.Collections.Generic.IEnumerable<CodeIssue> GetIssues(BaseRefactoringContext context)
 
43
                {
 
44
                        return new GatherVisitor (context).GetIssues ();
 
45
                }
 
46
 
 
47
                #endregion
 
48
                
 
49
                class GatherVisitor : GatherVisitorBase<LocalVariableNotUsedIssue>
 
50
                {
 
51
                        public GatherVisitor (BaseRefactoringContext ctx)
 
52
                                : base (ctx)
 
53
                        {
 
54
                        }
 
55
 
 
56
                        public override void VisitVariableInitializer (VariableInitializer variableInitializer)
 
57
                        {
 
58
                                base.VisitVariableInitializer (variableInitializer);
 
59
 
 
60
                                // check if variable is assigned
 
61
                                if (!variableInitializer.Initializer.IsNull)
 
62
                                        return;
 
63
                                var decl = variableInitializer.Parent as VariableDeclarationStatement;
 
64
                                if (decl == null)
 
65
                                        return;
 
66
 
 
67
                                var resolveResult = ctx.Resolve (variableInitializer) as LocalResolveResult;
 
68
                                if (resolveResult == null)
 
69
                                        return;
 
70
 
 
71
                                if (IsUsed (decl.Parent, resolveResult.Variable, variableInitializer))
 
72
                                        return;
 
73
 
 
74
                                AddIssue (variableInitializer.NameToken, ctx.TranslateString ("Remove unused local variable"),
 
75
                                        script =>
 
76
                                        {
 
77
                                                if (decl.Variables.Count == 1) {
 
78
                                                        script.Remove (decl);
 
79
                                                } else {
 
80
                                                        var newDeclaration = (VariableDeclarationStatement)decl.Clone ();
 
81
                                                        newDeclaration.Variables.Remove (
 
82
                                                                newDeclaration.Variables.FirstOrNullObject (v => v.Name == variableInitializer.Name));
 
83
                                                        script.Replace (decl, newDeclaration);
 
84
                                                }
 
85
                                        });
 
86
                        }
 
87
 
 
88
                        public override void VisitForeachStatement (ForeachStatement foreachStatement)
 
89
                        {
 
90
                                base.VisitForeachStatement (foreachStatement);
 
91
 
 
92
                                var resolveResult = ctx.Resolve (foreachStatement.VariableNameToken) as LocalResolveResult;
 
93
                                if (resolveResult == null)
 
94
                                        return;
 
95
 
 
96
                                if (IsUsed (foreachStatement, resolveResult.Variable, foreachStatement.VariableNameToken))
 
97
                                        return;
 
98
 
 
99
                                AddIssue (foreachStatement.VariableNameToken, ctx.TranslateString ("Local variable is never used"));
 
100
                        }
 
101
 
 
102
                        bool IsUsed(AstNode rootNode, IVariable variable, AstNode variableNode)
 
103
                        {
 
104
                                return ctx.FindReferences(rootNode, variable).Any(result => result.Node != variableNode);
 
105
                        }
 
106
                }
 
107
 
 
108
        }
 
109
}