Click here to Skip to main content
15,881,380 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 85.5K   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.Reflection.Emit;

namespace Arebis.Reflection
{
	/// <summary>
	/// Represents an IL instruction.
	/// </summary>
	/// <remarks>Source: http://www.codeproject.com/KB/cs/sdilreader.aspx (Sorin Serban)</remarks>
	public class ILInstruction
	{
		// Fields
		private ILanguageInfo languageInfo;
		private OpCode code;
		private object operand;
		private byte[] operandData;
		private int offset;

		public ILInstruction(ILanguageInfo languageInfo)
		{
			this.languageInfo = languageInfo ?? new DefaultLanguageInfo();
		}

		// Properties
		public OpCode Code
		{
			get { return code; }
			set { code = value; }
		}

		public object Operand
		{
			get { return operand; }
			set { operand = value; }
		}

		public byte[] OperandData
		{
			get { return operandData; }
			set { operandData = value; }
		}

		public int Offset
		{
			get { return offset; }
			set { offset = value; }
		}

		/// <summary>
		/// Returns a friendly string representation of this instruction.
		/// </summary>
		public string GetCode()
		{
			string result = "";
			result += GetExpandedOffset(offset) + " : " + code;
			if (operand != null)
			{
				switch (code.OperandType)
				{
					case OperandType.InlineField:
						System.Reflection.FieldInfo fOperand = ((System.Reflection.FieldInfo)operand);
						result += " " + this.languageInfo.GetFiendlyName(fOperand.FieldType) + " " +
							this.languageInfo.GetFiendlyName(fOperand.ReflectedType) +
							"::" + fOperand.Name + "";
						break;
					case OperandType.InlineMethod:
						try
						{
							System.Reflection.MethodInfo mOperand = (System.Reflection.MethodInfo)operand;
							result += " ";
							if (!mOperand.IsStatic) result += "instance ";
							result += this.languageInfo.GetFiendlyName(mOperand.ReturnType) +
								" " + this.languageInfo.GetFiendlyName(mOperand.ReflectedType) +
								"::" + mOperand.Name + "()";
						}
						catch
						{
							try
							{
								System.Reflection.ConstructorInfo mOperand = (System.Reflection.ConstructorInfo)operand;
								result += " ";
								if (!mOperand.IsStatic) result += "instance ";
								result += "void " +
									this.languageInfo.GetFiendlyName(mOperand.ReflectedType) +
									"::" + mOperand.Name + "()";
							}
							catch
							{
							}
						}
						break;
					case OperandType.ShortInlineBrTarget:
					case OperandType.InlineBrTarget:
						result += " " + GetExpandedOffset((int)operand);
						break;
					case OperandType.InlineType:
						result += " " + this.languageInfo.GetFiendlyName((Type)operand);
						break;
					case OperandType.InlineString:
						if (operand.ToString() == "\r\n") result += " \"\\r\\n\"";
						else result += " \"" + operand.ToString() + "\"";
						break;
					case OperandType.ShortInlineVar:
						result += operand.ToString();
						break;
					case OperandType.InlineI:
					case OperandType.InlineI8:
					case OperandType.InlineR:
					case OperandType.ShortInlineI:
					case OperandType.ShortInlineR:
						result += operand.ToString();
						break;
					case OperandType.InlineTok:
						if (operand is Type)
							result += ((Type)operand).FullName;
						else
							result += "not supported";
						break;

					default: result += "not supported"; break;
				}
			}
			return result;
		}

		/// <summary>
		/// Add enough zeros to a number as to be represented on 4 characters
		/// </summary>
		/// <param name="offset">
		/// The number that must be represented on 4 characters
		/// </param>
		/// <returns>
		/// </returns>
		private string GetExpandedOffset(long offset)
		{
			string result = offset.ToString();
			for (int i = 0; result.Length < 4; i++)
			{
				result = "0" + result;
			}
			return result;
		}
	}
}

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