diff --git a/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj b/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj index 01b9c83a2f..1506ab3d6e 100644 --- a/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj +++ b/ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj @@ -377,6 +377,7 @@ + diff --git a/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToVirtualFunctionFromConstructorIssue.cs b/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToVirtualFunctionFromConstructorIssue.cs new file mode 100644 index 0000000000..ffbb520888 --- /dev/null +++ b/ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToVirtualFunctionFromConstructorIssue.cs @@ -0,0 +1,84 @@ +// +// CallToVirtualFunctionFromConstructorIssue.cs +// +// Author: +// Simon Lindgren +// +// 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; + +namespace ICSharpCode.NRefactory.CSharp.Refactoring +{ + [IssueDescription("Virtual functions should not be called from constructors", + Description = "Warns about calls to virtual member functions occuring int the constructor.", + Category = IssueCategories.CodeQualityIssues, + Severity = Severity.Warning)] + public class CallToVirtualFunctionFromConstructorIssue : ICodeIssueProvider + { + public IEnumerable GetIssues(BaseRefactoringContext context) + { + return new GatherVisitor(context).GetIssues(); + } + + class GatherVisitor : GatherVisitorBase + { + readonly BaseRefactoringContext context; + + public GatherVisitor(BaseRefactoringContext context) : base (context) + { + this.context = context; + } + + public override void VisitConstructorDeclaration(ConstructorDeclaration constructorDeclaration) + { + var body = constructorDeclaration.Body; + if (body == null || body.IsNull) + return; + var callFinder = new VirtualCallFinderVisitor(context); + body.AcceptVisitor(callFinder); + FoundIssues.AddRange(callFinder.FoundIssues); + } + } + + class VirtualCallFinderVisitor: GatherVisitorBase + { + readonly BaseRefactoringContext context; + + public VirtualCallFinderVisitor(BaseRefactoringContext context) : base(context) + { + this.context = context; + } + + public override void VisitInvocationExpression(InvocationExpression invocationExpression) + { + var targetMethod = context.Resolve(invocationExpression) as InvocationResolveResult; + if (targetMethod == null) + return; + if (targetMethod.IsVirtualCall) + AddIssue(invocationExpression, + context.TranslateString("Calling virtual functions in constructors is bad practice.")); + } + } + } +} + diff --git a/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/CallToVirtualFunctionFromConstructorTests.cs b/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/CallToVirtualFunctionFromConstructorTests.cs new file mode 100644 index 0000000000..e4e961f257 --- /dev/null +++ b/ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/CallToVirtualFunctionFromConstructorTests.cs @@ -0,0 +1,78 @@ +// +// CallToVirtualFunctionFromConstructorTests.cs +// +// Author: +// Simon Lindgren +// +// 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 System; +using NUnit.Framework; +using ICSharpCode.NRefactory.CSharp.CodeActions; +using ICSharpCode.NRefactory.CSharp.Refactoring; + +namespace ICSharpCode.NRefactory.CSharp.CodeIssues +{ + [TestFixture] + public class CallToVirtualFunctionFromConstructorTests : InspectionActionTestBase + { + + [Test] + public void CatchesBadCase() + { + var input = @"class Foo +{ + Foo() + { + Bar(); + Bar(); + } + + virtual void Bar () + { + } +}"; + TestRefactoringContext context; + var issues = GetIssues(new CallToVirtualFunctionFromConstructorIssue(), input, out context); + Assert.AreEqual(2, issues.Count); + } + + [Test] + public void IgnoresGoodCase() + { + var input = @"class Foo +{ + Foo() + { + Bar(); + Bar(); + } + + void Bar () + { + } +}"; + TestRefactoringContext context; + var issues = GetIssues(new CallToVirtualFunctionFromConstructorIssue(), input, out context); + Assert.AreEqual(0, issues.Count); + } + } +} + diff --git a/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj b/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj index 3f1186836a..6bdbbb7fd4 100644 --- a/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj +++ b/ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj @@ -273,6 +273,7 @@ +