Migration of Fxcop Custom Rules to Visuatl Studio 2012

Question

I have an existing custom rule which was written in visual studio 2008 using fxocp SDK 1.35 and Microsoft.CCI 1.35. Now i am migrating it to latest version of Fxcop 11.0 and Microsoft .cci 11.0 using Vistual Studio 2012.
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
//using Microsoft.FxCop.Sdk.Introspection;
//using Microsoft.Cci;
using Microsoft.FxCop.Sdk;
using System.Collections;
using System.IO;
namespace LDOFxCopCustomRules.Rules.Design
class DisposableObjectsShouldBeDisposed : BaseDesignRules
string sFileName = System.Configuration.ConfigurationSettings.AppSettings["FolderForOutput"] + "\\" + @"DisposableObjectsShouldBeDisposed.Xls";
bool bDisplayErrors = String.IsNullOrEmpty(System.Configuration.ConfigurationSettings.AppSettings["FolderForOutput"]);
//string sExceptionLogFileName = @"D:\RTE.txt";
static string sLockString = "Lock";
string sFormat = "{0}\t{1}\t{2}\t{3}\n";
string sAssemblyName;
string sClassName;
string sLineNumber;
// Fields
private Hashtable m_fieldsOwnedByType;
private Hashtable m_fieldsWithDispose;
private Method m_method;
// Methods
public DisposableObjectsShouldBeDisposed()
: base("DisposableObjectsShouldBeDisposed")
this.m_fieldsWithDispose = new Hashtable();
this.m_fieldsOwnedByType = new Hashtable();
if (!bDisplayErrors && !File.Exists(sFileName))
if (!bShowInAllReport)
lock (sLockString)
File.WriteAllText(sFileName, string.Format(sFormat, "Assembly", "Class", "Method (fully qualified name)", "Line number"));
public override ProblemCollection Check(Member member)
string sTemp = member.FullName;
bool bFinally = false;
bool bDataReader = false;
bool bDisposedCalled = false;
int nDataReaderCount = 0;
Local oCheckLocal;
Method oMethod = null;
int nCurrent = 0;
InstructionList oList = null;
this.m_method = RuleUtilities.GetMethod(member);
if (this.m_method == null)
return null;
this.m_fieldsWithDispose.Clear();
this.m_fieldsOwnedByType.Clear();
//if (!this.m_method.DeclaringType.IsAssignableTo(SystemTypes.IDisposable))
// return null;
//if (RuleUtilities.ExtendsControl(this.m_method.DeclaringType))
// return null;
//if (!RuleUtilities.IsDisposeBool(this.m_method) && (!RuleUtilities.IsDisposeMethod(this.m_method) || HasDisposeBoolMethod(this.m_method.DeclaringType)))
// return null;
if (this.m_method.DeclaringType.IsAssignableTo(SystemTypes.IDisposable))
if (RuleUtilities.ExtendsControl(this.m_method.DeclaringType))
return null;
if (!RuleUtilities.IsDisposeBool(this.m_method) && (!RuleUtilities.IsDisposeMethod(this.m_method) || HasDisposeBoolMethod(this.m_method.DeclaringType)))
return null;
sClassName = m_method.DeclaringType.Name.Name;
sAssemblyName = m_method.DeclaringType.DeclaringModule.ContainingAssembly.ModuleName;
MemberList members = this.m_method.DeclaringType.Members;
for (int i = 0; i < members.Length; i++)
switch (members[i].NodeType)
case NodeType.Field:
Field field = members[i] as Field;
if (!field.IsStatic && field.Type.IsAssignableTo(SystemTypes.IDisposable))
this.m_fieldsWithDispose[field] = null;
break;
case NodeType.InstanceInitializer:
case NodeType.Method:
this.VisitMethod(members[i] as Method);
break;
new DisposeVisitor(this.m_fieldsWithDispose).Visit(this.m_method);
if (this.m_fieldsWithDispose.Count > 0)
foreach (Field field2 in this.m_fieldsWithDispose.Keys)
if (this.m_fieldsOwnedByType.Contains(field2))
string str = RuleUtilities.Format(this.m_method.DeclaringType);
string str2 = RuleUtilities.Format(field2.Type);
sLineNumber = field2.SourceContext.StartLine.ToString();
Problem item = new Problem(base.GetResolution(new string[] { str, field2.Name.Name, str2 }), field2.Name.Name);
if (bDisplayErrors)
base.Problems.Add(item);
else
if (bShowInAllReport)
lock (LockClass.objLockAllReport)
File.AppendAllText(sSingleReportName, string.Format(sSingleReportFormat, sAssemblyName, sClassName, m_method.FullName, sLineNumber, "DisposableObjectsShouldBeDisposed"));
else
lock (sLockString)
File.AppendAllText(sFileName, string.Format(sFormat, sAssemblyName, sClassName, m_method.FullName, sLineNumber));
else
if (member.NodeType == NodeType.Method)
oMethod = member as Method;
// The below block is to identify if any of the method's class is implemented from the interface IDataReader.
// If that is the case, the method will be skipped and next method will be picked.
// Ideally, this should be changed to scanning each class, skipping if it has implemented IDataReader and then
// scan the methods for proper usage of IDataReader. But due to time constraints, this change is not done
TypeNode typ = oMethod.DeclaringType;
InterfaceList intList = typ.Interfaces; // get the list of interfaces of the class and check for IDataReader
foreach (Interface intf in intList)
if (intf.FullName.Contains("IDataReader"))
return null;
// Start the actual logic
if (oMethod != null)
oList = oMethod.Instructions;
Instruction oInstruction;
for (nCurrent = 0; nCurrent < oList.Length; nCurrent++)
oInstruction = oList[nCurrent];
if (oInstruction.OpCode == OpCode._Locals)
LocalList oLocalList = oInstruction.Value as LocalList;
int nCount = oLocalList.Length;
for (int nIdx = 0; nIdx < nCount; nIdx++)
if (oLocalList[nIdx].Type.Name.Name == "IDataReader")
bDataReader = true;
nDataReaderCount++;
if (nDataReaderCount > 0)
if (oInstruction.OpCode == OpCode._Finally)
bFinally = true;
if (bFinally)
if (oInstruction.OpCode == OpCode.Callvirt)
oCheckLocal = oList[nCurrent - 1].Value as Local;
if (oCheckLocal != null && oCheckLocal.Type != null && oCheckLocal.Name != null && oCheckLocal.Type.Name.Name != null && oCheckLocal.Type.Name.Name == "IDataReader")
bDisposedCalled = true;
//nDataReaderCount--;
// Microsoft.FxCop.Sdk.Problem oProblem = new Microsoft.FxCop.Sdk.Problem(base.GetResolution(sTemp1), oMethod.Name.Name);
if (bDataReader && !bDisposedCalled)
sClassName = oMethod.DeclaringType.Name.Name;
sAssemblyName = oMethod.DeclaringType.DeclaringModule.ContainingAssembly.ModuleName;
sLineNumber = nCurrent > 0 && nCurrent < oList.Length? oList[0].SourceContext.StartLine.ToString().Trim() : string.Empty;
if (bDisplayErrors)
Microsoft.FxCop.Sdk.Problem oProblem = new Microsoft.FxCop.Sdk.Problem(base.GetResolution(sTemp), sClassName);
base.Problems.Add(oProblem);
else
if (bShowInAllReport)
lock (LockClass.objLockAllReport)
File.AppendAllText(sSingleReportName, string.Format(sSingleReportFormat, sAssemblyName, sClassName, m_method.FullName, sLineNumber, "DisposableObjectsShouldBeDisposed"));
else
lock (sLockString)
File.AppendAllText(sFileName, string.Format(sFormat, sAssemblyName, sClassName, oMethod.FullName, sLineNumber));
return base.Problems;
private static bool HasDisposeBoolMethod(TypeNode type)
MemberList members = type.Members;
int num = 0;
int length = members.Length;
while (num < length)
Method method = members[num] as Method;
if ((method != null) && RuleUtilities.IsDisposeBool(method))
return true;
num++;
return false;
public override Statement VisitAssignmentStatement(AssignmentStatement assignment)
MemberBinding target = assignment.Target as MemberBinding;
if (target != null)
Field boundMember = target.BoundMember as Field;
if (((boundMember != null) && (boundMember.DeclaringType == this.m_method.DeclaringType)) && (assignment.Source is Construct))
this.m_fieldsOwnedByType[boundMember] = null;
return base.VisitAssignmentStatement(assignment);
// Properties
public override TargetVisibilities TargetVisibility
get
return TargetVisibilities.All;
// Nested Types
private class DisposeVisitor : StandardVisitor
// Fields
private Hashtable m_fieldsWithDispose;
private Method m_method;
private Hashtable m_recursionCache = new Hashtable();
private Hashtable m_variableToFieldMap = new Hashtable();
// Methods
internal DisposeVisitor(Hashtable fieldsWithDispose)
this.m_fieldsWithDispose = fieldsWithDispose;
public override Statement VisitAssignmentStatement(AssignmentStatement assignment)
Local target = assignment.Target as Local;
if (target != null)
MemberBinding source = assignment.Source as MemberBinding;
if (source != null)
Field boundMember = source.BoundMember as Field;
if ((boundMember != null) && (boundMember.DeclaringType == this.m_method.DeclaringType))
this.m_variableToFieldMap[target] = boundMember;
return base.VisitAssignmentStatement(assignment);
public override Method VisitMethod(Method method)
this.m_method = method;
return base.VisitMethod(method);
public override Expression VisitMethodCall(MethodCall call)
MemberBinding callee = call.Callee as MemberBinding;
if (callee != null)
Method boundMember = callee.BoundMember as Method;
if (boundMember == null)
return base.VisitMethodCall(call);
MemberBinding targetObject = callee.TargetObject as MemberBinding;
Field key = null;
if (targetObject == null)
Local local = callee.TargetObject as Local;
if (local != null)
key = this.m_variableToFieldMap[local] as Field;
else
key = targetObject.BoundMember as Field;
if (((key != null) && this.m_fieldsWithDispose.ContainsKey(key)) && (((boundMember.Name.Name == "Dispose") || (boundMember.Name.Name == "Close")) || ((boundMember.Name.Name == "Clear") && boundMember.DeclaringType.IsAssignableTo(FrameworkTypes.HashAlgorithm))))
this.m_fieldsWithDispose.Remove(key);
else if ((boundMember.DeclaringType == this.m_method.DeclaringType) && !this.m_recursionCache.Contains(boundMember))
this.m_recursionCache[boundMember] = null;
this.VisitMethod(boundMember);
return base.VisitMethodCall(call);
Below errors are raised. Please let me know the solution
1. Error 2 Inconsistent accessibility: base class 'Microsoft.FxCop.Sdk.StandardVisitor' is less accessible than class 'LDOFxCopCustomRules.Rules.Design.DisposableObjectsShouldBeDisposed.DisposeVisitor' D:\LDOFxCopCustomRules\DisposableObjectsShouldBeDisposed.cs 287 23 LDOFxCopCustomRules
Error 3 'Microsoft.FxCop.Sdk.StandardVisitor' is inaccessible due to its protection level D:\LDOFxCopCustomRules\DisposableObjectsShouldBeDisposed.cs 287 40 LDOFxCopCustomRules
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
//using Microsoft.FxCop.Sdk.Introspection;
//using Microsoft.Cci;
using Microsoft.FxCop.Sdk;
using System.Collections;
using System.IO;
namespace LDOFxCopCustomRules.Rules.Design
class AvoidUnusedParameters : BaseDesignRules
string sFileName = System.Configuration.ConfigurationSettings.AppSettings["FolderForOutput"] + "\\" + @"AvoidUnusedParameters.Xls";
bool bDisplayErrors = String.IsNullOrEmpty(System.Configuration.ConfigurationSettings.AppSettings["FolderForOutput"]);
//string sExceptionLogFileName = @"D:\RTE.txt";
static string sLockString = "Lock";
string sFormat = "{0}\t{1}\t{2}\t{3}\n";
string sAssemblyName;
string sClassName;
string sLineNumber;
private Hashtable m_parameterUsage;
public AvoidUnusedParameters()
: base("AvoidUnusedParameters")
this.m_parameterUsage = new Hashtable();
if (!bDisplayErrors && !File.Exists(sFileName))
if (!bShowInAllReport)
lock (sLockString)
File.WriteAllText(sFileName, string.Format(sFormat, "Assembly", "Class", "Method (fully qualified name)", "Line number"));
public override ProblemCollection Check(Member member)
Method method = member as Method;
if (!ShouldAnalyze(method))
return null;
this.m_parameterUsage.Clear();
if (CallGraph.FunctionPointersFor(method).Length > 0)
return null;
if (method.DeclaringType.IsAssignableTo(SystemTypes.Delegate))
return null;
if (RuleUtilities.IsEventHandling(method))
return null;
if (RuleUtilities.IsVisualBasicModule(method.DeclaringType.DeclaringModule) && (method.Name.Name == "Dispose__Instance__"))
return null;
if (RuleUtilities.HasCustomAttribute(method, SystemTypes.ConditionalAttribute))
return null;
for (int i = 0; i < method.Instructions.Length; i++)
switch (method.Instructions[i].OpCode)
case OpCode.Ldarg_0:
case OpCode.Ldarg_1:
case OpCode.Ldarg_2:
case OpCode.Ldarg_3:
case OpCode.Ldarg_S:
case OpCode.Ldarga_S:
case OpCode.Ldarg:
case OpCode.Ldarga:
Parameter parameter = method.Instructions[i].Value as Parameter;
this.m_parameterUsage[parameter] = null;
break;
sClassName = method.DeclaringType.Name.Name;
sAssemblyName = method.DeclaringType.DeclaringModule.ContainingAssembly.ModuleName;
sLineNumber = method.SourceContext.StartLine.ToString();
for (int j = 0; j < method.Parameters.Length; j++)
Parameter key = method.Parameters[j];
if (!this.m_parameterUsage.ContainsKey(key))
FixCategories breaking = FixCategories.Breaking;
if (!method.IsVisibleOutsideAssembly)
breaking = FixCategories.NonBreaking;
string str = RuleUtilities.Format(method);
string name = method.Parameters[j].Name.Name;
Problem item = new Problem(base.GetResolution(new string[] { name, str }), name);
item.FixCategory = breaking;
if (bDisplayErrors)
base.Problems.Add(item);
else
if (bShowInAllReport)
lock (LockClass.objLockAllReport)
File.AppendAllText(sSingleReportName, string.Format(sSingleReportFormat, sAssemblyName, sClassName, method.FullName, sLineNumber, "AvoidUnusedParameters"));
else
lock (sLockString)
File.AppendAllText(sFileName, string.Format(sFormat, sAssemblyName, sClassName, method.FullName, sLineNumber));
this.m_parameterUsage.Clear();
return base.Problems;
private static bool IsVSUnitTestInitializer(Method method)
if ((method.IsStatic && (method.ReturnType == SystemTypes.Void)) && ((method.Parameters.Length == 1) && (method.Parameters[0].Type.Name.Name == "TestContext")))
for (int i = 0; i < method.Attributes.Length; i++)
AttributeNode node = method.Attributes[i];
if ((node.Type.Name.Name == "AssemblyInitializeAttribute") || (node.Type.Name.Name == "ClassInitializeAttribute"))
return true;
return false;
private static bool ShouldAnalyze(Method method)
if (method == null)
return false;
if ((method.Parameters.Length == 0) && method.IsStatic)
return false;
if (method.IsVirtual)
return false;
if (method.IsExtern)
return false;
if (method.IsAbstract)
return false;
if (RuleUtilities.IsFinalizer(method))
return false;
if (method.Name.Name == "__ENCUpdateHandlers")
return false;
Module declaringModule = method.DeclaringType.DeclaringModule;
if (method.Name.Name.StartsWith("__", StringComparison.Ordinal) && RuleUtilities.IsAspAssembly(declaringModule))
return false;
if (RuleUtilities.IsISerializableConstructor(method))
return false;
if (IsVSUnitTestInitializer(method))
return false;
if (RuleUtilities.MethodOrItsTypeMarkedWithGeneratedCode(method))
return false;
return true;
// Properties
public override TargetVisibilities TargetVisibility
get
return TargetVisibilities.All;
Below Errors are raised
Error 8 The name 'SystemTypes' does not exist in the current context D:\AvoidUnusedParameters.cs 53 49 LDOFxCopCustomRules
Error 9 'Microsoft.FxCop.Sdk.RuleUtilities' does not contain a definition for 'IsVisualBasicModule' D:\AvoidUnusedParameters.cs 61 27 LDOFxCopCustomRules
Error 11 'Microsoft.FxCop.Sdk.BaseIntrospectionRule.FixCategories' is a 'property' but is used like a 'type' D:\AvoidUnusedParameters.cs 98 17 LDOFxCopCustomRules
Error 12 The best overloaded method match for 'Microsoft.FxCop.Sdk.RuleUtilities.Format(Microsoft.FxCop.Sdk.AttributeNode)' has some invalid arguments D:\AvoidUnusedParameters.cs 103 30 LDOFxCopCustomRules
Error 13 Argument 1: cannot convert from 'Microsoft.FxCop.Sdk.Method' to 'Microsoft.FxCop.Sdk.AttributeNode' D:\AvoidUnusedParameters.cs 103 51 LDOFxCopCustomRules
Error 14 The name 'SystemTypes' does not exist in the current context D:\AvoidUnusedParameters.cs 136 55 LDOFxCopCustomRules
Error 16 The type or namespace name 'Module' could not be found (are you missing a using directive or an assembly reference?) D:\LDOFxCopCustomRules\AvoidUnusedParameters.cs 180 9 LDOFxCopCustomRules
Error 17 'Microsoft.FxCop.Sdk.RuleUtilities' does not contain a definition for 'IsAspAssembly' D:\AvoidUnusedParameters.cs 181 90 LDOFxCopCustomRules
Error 18 'Microsoft.FxCop.Sdk.RuleUtilities' does not contain a definition for 'MethodOrItsTypeMarkedWithGeneratedCode' D:\AvoidUnusedParameters.cs 193 27 LDOFxCopCustomRules

Answer 1

Hi sathishkumarV,
I am trying to involve someone familiar with this topic to further look at this issue. There might
be some time delay. Appreciate your patience.
Best Regards,
Jack
We are trying to better understand customer views on social support experience, so your participation in this interview project would be greatly appreciated if you have time. Thanks for helping make community forums a great place.
Click
HERE to participate the survey.