Browse Source

[CodeIssue] Add CallToVirtualFunctionFromConstructorIssue.

newNRvisualizers
Simon Lindgren 14 years ago
parent
commit
47da624e7e
  1. 1
      ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj
  2. 84
      ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToVirtualFunctionFromConstructorIssue.cs
  3. 78
      ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/CallToVirtualFunctionFromConstructorTests.cs
  4. 1
      ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj

1
ICSharpCode.NRefactory.CSharp/ICSharpCode.NRefactory.CSharp.csproj

@ -377,6 +377,7 @@ @@ -377,6 +377,7 @@
<Compile Include="Refactoring\CodeActions\AddCatchTypeAction.cs" />
<Compile Include="Refactoring\CodeIssues\SetterDoesNotUseValueParameterIssue.cs" />
<Compile Include="Refactoring\CodeIssues\IncorrectExceptionParameterOrderingIssue.cs" />
<Compile Include="Refactoring\CodeIssues\CallToVirtualFunctionFromConstructorIssue.cs" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\ICSharpCode.NRefactory\ICSharpCode.NRefactory.csproj">

84
ICSharpCode.NRefactory.CSharp/Refactoring/CodeIssues/CallToVirtualFunctionFromConstructorIssue.cs

@ -0,0 +1,84 @@ @@ -0,0 +1,84 @@
//
// CallToVirtualFunctionFromConstructorIssue.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;
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<CodeIssue> 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."));
}
}
}
}

78
ICSharpCode.NRefactory.Tests/CSharp/CodeIssues/CallToVirtualFunctionFromConstructorTests.cs

@ -0,0 +1,78 @@ @@ -0,0 +1,78 @@
//
// CallToVirtualFunctionFromConstructorTests.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 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);
}
}
}

1
ICSharpCode.NRefactory.Tests/ICSharpCode.NRefactory.Tests.csproj

@ -273,6 +273,7 @@ @@ -273,6 +273,7 @@
<Compile Include="CSharp\CodeActions\AddCatchTypeTests.cs" />
<Compile Include="CSharp\CodeIssues\SetterDoesNotUseValueParameterTests.cs" />
<Compile Include="CSharp\CodeIssues\IncorrectExceptionParameterOrderingTests.cs" />
<Compile Include="CSharp\CodeIssues\CallToVirtualFunctionFromConstructorTests.cs" />
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\..\Mono.Cecil\Mono.Cecil.csproj">

Loading…
Cancel
Save