Click here to Skip to main content
15,897,273 members
Articles / Programming Languages / C#

Static Code Analysis

Rate me:
Please Sign up or sign in to vote.
4.97/5 (34 votes)
15 Mar 2010CPOL16 min read 87.4K   1.1K   63  
A static code analyzer building method call networks + sample applications
This article describes the operation of a method-based static code analyzer for .NET that constructs in-memory method call networks of compiled assemblies. You will also see a concrete application of static code analysis to generate a website providing easy insights on a sample application.
using System;
using System.Collections.Generic;
using System.Text;
using System.Xml;

using BaseTypesCache=System.Collections.Generic.Dictionary<System.Type, System.Collections.Generic.HashSet<System.String>>;

namespace Arebis.CodeAnalysis.Static.Processors.Rules
{
	[CodeModelMatchingRule(
        "basetyperule", 
        "Matches methods on subtypes of the given type.",
        "type=Name of the base type.|includeinterfaces=Whether the type can be an interface.")]
	public class BaseTypeMatchingRule : BaseMatchingRule
	{
		private const string BasetypesCacheKey = "BaseTypeMatchingRule.BaseTypesCache";

		private string typeName;
        private bool includeInterfaces = false;

        private BaseTypesCache baseTypesCache;

		public override void Initialize(XmlNode ruleInstance)
		{
            // Initialize from XmlNode:
            this.typeName = ruleInstance.Attributes["type"].Value;
            if (ruleInstance.Attributes["includeinterfaces"] != null)
                this.includeInterfaces = Convert.ToBoolean(ruleInstance.Attributes["includeinterfaces"].Value);

            // Initialize cache on context:
            if (!this.Context.Properties.ContainsKey(BasetypesCacheKey))
                this.Context.Properties[BasetypesCacheKey] = new BaseTypesCache();

            // Keep local reference to cache:
            this.baseTypesCache
                = (BaseTypesCache)this.Context.Properties[BasetypesCacheKey];
        }

		public override bool Matches(ModelMethod method)
		{
			return this.Matches(method.DeclaringType);
		}
		
		private bool Matches(Type type)
		{
			// Retrieve basetypes list in cache for given type:
			HashSet<String> baseTypes;
            if (!this.baseTypesCache.TryGetValue(type, out baseTypes))
			{
                baseTypes = new HashSet<String>();
				CollectBaseTypes(type, baseTypes);
                lock (this.baseTypesCache)
                {
                    this.baseTypesCache[type] = baseTypes;
                }
			}

			// Test match:
			return baseTypes.Contains(this.typeName);
		}

		private void CollectBaseTypes(Type type, HashSet<String> basetypenames)
		{
			if (type.FullName != null)
				basetypenames.Add(type.FullName);
            if (type.BaseType != null)
                CollectBaseTypes(type.BaseType, basetypenames);

            if (this.includeInterfaces)
                foreach (Type iface in type.GetInterfaces())
                    CollectBaseTypes(iface, basetypenames);
		}
	}
}

By viewing downloads associated with this article you agree to the Terms of Service and the article's licence.

If a file you wish to view isn't highlighted, and is a text file (not binary), please let us know and we'll add colourisation support for it.

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)


Written By
Architect AREBIS
Belgium Belgium
Senior Software Architect and independent consultant.

Comments and Discussions