File: DoNotCallOverridableMethodsInConstructorIssue.cs

package info (click to toggle)
nrefactory 5.3.0%2B20130718.73b6d0f-4.1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm, bullseye
  • size: 15,720 kB
  • sloc: cs: 296,018; makefile: 24; ansic: 7; sh: 2
file content (167 lines) | stat: -rw-r--r-- 5,963 bytes parent folder | download | duplicates (4)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
//
// DoNotCallOverridableMethodsInConstructorIssue.cs
//
// Author:
//       Simon Lindgren <simon.n.lindgren@gmail.com>
//
// Copyright (c) 2012 Simon Lindgren
//
// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
// THE SOFTWARE.
using ICSharpCode.NRefactory.CSharp.Refactoring;
using System.Collections.Generic;
using ICSharpCode.NRefactory.Semantics;
using ICSharpCode.NRefactory.Refactoring;

namespace ICSharpCode.NRefactory.CSharp.Refactoring
{
	[IssueDescription("Virtual member call in constructor",
	                  Description = "Warns about calls to virtual member functions occuring in the constructor.",
	                  Category = IssueCategories.CodeQualityIssues,
	                  Severity = Severity.Warning,
                      ResharperDisableKeyword = "DoNotCallOverridableMethodsInConstructor")]
	public class DoNotCallOverridableMethodsInConstructorIssue : ICodeIssueProvider
	{
	    public IEnumerable<CodeIssue> GetIssues(BaseRefactoringContext context)
		{
			var gv = new GatherVisitor(context);
			context.RootNode.AcceptVisitor(gv);
			return gv.CallFinder.FoundIssues;
		}
		
		class GatherVisitor : GatherVisitorBase<DoNotCallOverridableMethodsInConstructorIssue>
		{
			internal readonly VirtualCallFinderVisitor CallFinder;

			public GatherVisitor(BaseRefactoringContext context) : base (context)
			{
				CallFinder = new VirtualCallFinderVisitor(context);
			}

			bool isSealedType;

			public override void VisitTypeDeclaration(TypeDeclaration typeDeclaration)
			{
				if (typeDeclaration.ClassType != ClassType.Class && typeDeclaration.ClassType != ClassType.Struct)
					return;
				bool oldIsSealedType = isSealedType;
				isSealedType = typeDeclaration.Modifiers.HasFlag(Modifiers.Sealed);
			    CallFinder.CurrentType = typeDeclaration;
				base.VisitTypeDeclaration(typeDeclaration);
				isSealedType = oldIsSealedType;
			}

			public override void VisitConstructorDeclaration(ConstructorDeclaration constructorDeclaration)
			{
				if (isSealedType)
					return;
				var body = constructorDeclaration.Body;
				if (body == null || body.IsNull)
					return;
				body.AcceptVisitor(CallFinder);
			}

			public override void VisitMethodDeclaration(MethodDeclaration methodDeclaration)
			{
				// nothing
			}

			public override void VisitPropertyDeclaration(PropertyDeclaration propertyDeclaration)
			{
				// nothing
			}

			public override void VisitIndexerExpression(IndexerExpression indexerExpression)
			{
				// nothing
			}

			public override void VisitCustomEventDeclaration(CustomEventDeclaration eventDeclaration)
			{
				// nothing
			}

			public override void VisitEventDeclaration(EventDeclaration eventDeclaration)
			{
				// nothing
			}

			public override void VisitFieldDeclaration(FieldDeclaration fieldDeclaration)
			{
				// nothing
			}

			public override void VisitFixedFieldDeclaration(FixedFieldDeclaration fixedFieldDeclaration)
			{
				// nothing
			}
		}

		class VirtualCallFinderVisitor: GatherVisitorBase<DoNotCallOverridableMethodsInConstructorIssue>
		{
			readonly BaseRefactoringContext context;
            public TypeDeclaration CurrentType;
			public VirtualCallFinderVisitor(BaseRefactoringContext context) : base(context)
			{
				this.context = context;
			}

		    

		    public override void VisitInvocationExpression(InvocationExpression invocationExpression)
			{
				base.VisitInvocationExpression(invocationExpression);
				if (!IsCallDependentOnCurrentInstance(invocationExpression))
					// Call within current class scope without 'this' or 'base'
					return;
				var targetMethod = context.Resolve(invocationExpression) as InvocationResolveResult;
				if (targetMethod == null)
					return;
				if (targetMethod.IsVirtualCall) {
					AddIssue(invocationExpression,
                             context.TranslateString("Virtual member call in constructor"),
                             new CodeAction(string.Format(context.TranslateString("Make class '{0}' sealed"), CurrentType.Name),
                             script => script.ChangeModifier(CurrentType, CurrentType.Modifiers | Modifiers.Sealed), 
                             invocationExpression));
				}
			}

			bool IsCallDependentOnCurrentInstance(InvocationExpression invocationExpression)
			{
				if (invocationExpression.Target is IdentifierExpression)
					// Call within current class scope without 'this' or 'base'
					return true;
				var expression = invocationExpression.Target as MemberReferenceExpression;
				if (expression == null || expression.Target is ThisReferenceExpression)
					// Call within current class scope using 'this' or 'base'
					return true;
				return false;
			}
			
			public override void VisitLambdaExpression(LambdaExpression lambdaExpression)
			{
				// ignore lambdas
			}
			
			public override void VisitAnonymousMethodExpression(AnonymousMethodExpression anonymousMethodExpression)
			{
				// ignore anonymous methods
			}
		}
	}
}