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

« back to all changes in this revision

Viewing changes to external/nrefactory/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/MethodNeverReturnsIssue.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
// MethodNeverReturnsIssue.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 System.Collections.Generic;
 
28
using ICSharpCode.NRefactory.CSharp.Analysis;
 
29
 
 
30
namespace ICSharpCode.NRefactory.CSharp.Refactoring
 
31
{
 
32
        [IssueDescription ("Method never returns",
 
33
                Description = "Method does not reach its end or a 'return' statement by any of possible execution paths.",
 
34
                Category = IssueCategories.CodeQualityIssues,
 
35
                Severity = Severity.Warning,
 
36
                IssueMarker = IssueMarker.Underline)]
 
37
        public class MethodNeverReturnsIssue : ICodeIssueProvider
 
38
        {
 
39
                public IEnumerable<CodeIssue> GetIssues (BaseRefactoringContext context)
 
40
                {
 
41
                        return new GatherVisitor (context).GetIssues ();
 
42
                }
 
43
 
 
44
                class GatherVisitor : GatherVisitorBase<MethodNeverReturnsIssue>
 
45
                {
 
46
                        public GatherVisitor(BaseRefactoringContext ctx)
 
47
                                : base (ctx)
 
48
                        {
 
49
                        }
 
50
 
 
51
                        public override void VisitMethodDeclaration (MethodDeclaration methodDeclaration)
 
52
                        {
 
53
                                base.VisitMethodDeclaration (methodDeclaration);
 
54
 
 
55
                                // partial method
 
56
                                if (methodDeclaration.Body.IsNull)
 
57
                                        return;
 
58
 
 
59
                                var reachability = ctx.CreateReachabilityAnalysis(methodDeclaration.Body);
 
60
                                bool hasReachableReturn = false;
 
61
                                foreach (var statement in reachability.ReachableStatements) {
 
62
                                        if (statement is ReturnStatement || statement is ThrowStatement || statement is YieldBreakStatement) {
 
63
                                                hasReachableReturn = true;
 
64
                                                break;
 
65
                                        }
 
66
                                }
 
67
                                if (!hasReachableReturn && !reachability.IsEndpointReachable(methodDeclaration.Body)) {
 
68
                                        AddIssue (methodDeclaration.NameToken, 
 
69
                                                ctx.TranslateString ("Method never reaches its end or a 'return' statement."));
 
70
                                }
 
71
                        }
 
72
                }
 
73
        }
 
74
}