Click here to Skip to main content
15,885,978 members
Articles / Programming Languages / C#

A .NET State Machine Toolkit - Part I

Rate me:
Please Sign up or sign in to vote.
4.80/5 (69 votes)
29 Mar 2007CPOL18 min read 409.9K   2.5K   290  
An introduction to the .NET State Machine Toolkit.
/*
 * Created by: Leslie Sanford
 * 
 * Contact: jabberdabber@hotmail.com
 * 
 * Last modified: 10/13/2005
 */

using System;
using System.CodeDom;
using System.Collections;

namespace StateMachineToolkit
{
	/// <summary>
	/// Builds the method responsible for initializing the transitions.
	/// </summary>
    internal class TransitionInitializeBuilder
	{
        #region TransitionInitializeBuilder Members

        #region Fields

        // The state machine's transitions.
        private IDictionary stateTransitions;

        private string stateMachineName = string.Empty;

        // The built method.
        private CodeMemberMethod result = new CodeMemberMethod();

        #endregion

        #region Construction

        /// <summary>
        /// Initializes a new instance of the TransitionInitializeBuilder class
        /// with the specified state transition table.
        /// </summary>
        /// <param name="stateTransitions">
        /// The state transitions. 
        /// </param>
		public TransitionInitializeBuilder(IDictionary stateTransitions)
		{
            this.stateTransitions = stateTransitions;
		}

        #endregion

        #region Methods

        /// <summary>
        /// Builds the method.
        /// </summary>
        public void Build()
        {
            result = new CodeMemberMethod();
            result.Name = "InitializeTransitions";
            result.Attributes = MemberAttributes.Private;

            CodeVariableDeclarationStatement transDeclaration = 
                new CodeVariableDeclarationStatement(typeof(Transition), "trans");

            result.Statements.Add(transDeclaration);
            
            CodeThisReferenceExpression thisReference = 
                new CodeThisReferenceExpression();
            CodeTypeReferenceExpression stateMachineReference = 
                new CodeTypeReferenceExpression(StateMachineName);
            CodeExpression sourceStateReference;
            CodeExpression eventIDReference;
            CodeExpression guardReference;
            CodeExpression actionReference;            
            CodeExpression targetStateReference;
            CodeObjectCreateExpression transCreate;
            CodePropertyReferenceExpression actionProperty;
            CodePropertyReferenceExpression transProperty;
            CodeMethodInvokeExpression addInvoke;
            CodeVariableReferenceExpression transReference = new CodeVariableReferenceExpression("trans");
            CodeAssignStatement transAssign;

            actionProperty = new CodePropertyReferenceExpression(transReference, "Actions");

            TransitionRowCollection transRowCollection;

            foreach(DictionaryEntry entry in stateTransitions)
            {
                transRowCollection = (TransitionRowCollection)entry.Value;

                foreach(TransitionRow transRow in transRowCollection)
                {
                    sourceStateReference = new CodeFieldReferenceExpression(
                        thisReference, "state" + entry.Key.ToString());

                    eventIDReference = new CodeFieldReferenceExpression(
                        stateMachineReference, transRow.Event + "ID");

                    // If there is a guard for this transition.
                    if(transRow.Guard != null && transRow.Guard != string.Empty)
                    {
                        // Create a reference to the guard.
                        guardReference = new CodeFieldReferenceExpression(
                            thisReference, "guard" + transRow.Guard);
                    }
                    // Else there is no guard for this transition.
                    else
                    {
                        // Create a null reference for the guard.
                        guardReference = new CodePrimitiveExpression(null);
                    }                    

                    // If there is a target state for this transition.
                    if(transRow.Target != null && transRow.Target != string.Empty)
                    {
                        // Create a reference to the state target.
                        targetStateReference = new CodeFieldReferenceExpression(
                            thisReference, "state" + transRow.Target);
                    }
                    // Else there is no target state for this transition (it is an 
                    // internal transition).
                    else
                    {
                        // Create a null reference for the target state.
                        targetStateReference = new CodePrimitiveExpression(null);
                    }

                    //
                    // Create and initialize the transition and add it to the collection
                    // of transitions for the specified state.
                    //

                    transCreate = new CodeObjectCreateExpression();

                    transCreate.CreateType = new CodeTypeReference(typeof(Transition));
                    transCreate.Parameters.Add(guardReference);
                    transCreate.Parameters.Add(targetStateReference);

                    transAssign = new CodeAssignStatement(transReference, transCreate);

                    result.Statements.Add(transAssign);

                    foreach(ActionRow actionRow in transRow.Actions)
                    {
                        actionReference = new CodeFieldReferenceExpression(thisReference, "action" + actionRow.Name);
                        addInvoke = new CodeMethodInvokeExpression(actionProperty, "Add", actionReference);
                        result.Statements.Add(addInvoke);
                    }

                    transProperty = new CodePropertyReferenceExpression(
                        sourceStateReference, "Transitions");

                    addInvoke = new CodeMethodInvokeExpression(transProperty,
                        "Add", new CodeExpression[] { eventIDReference, transReference });
                
                    result.Statements.Add(addInvoke);
                }
            }
        }

        #endregion

        #region Properties

        public string StateMachineName
        {
            get
            {
                return stateMachineName;
            }
            set
            {
                stateMachineName = value;
            }
        }

        /// <summary>
        /// Gets the built method.
        /// </summary>
        public CodeMemberMethod Result
        {
            get
            {
                return result;
            }
        }

        #endregion

        #endregion
	}
}

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
United States United States
Aside from dabbling in BASIC on his old Atari 1040ST years ago, Leslie's programming experience didn't really begin until he discovered the Internet in the late 90s. There he found a treasure trove of information about two of his favorite interests: MIDI and sound synthesis.

After spending a good deal of time calculating formulas he found on the Internet for creating new sounds by hand, he decided that an easier way would be to program the computer to do the work for him. This led him to learn C. He discovered that beyond using programming as a tool for synthesizing sound, he loved programming in and of itself.

Eventually he taught himself C++ and C#, and along the way he immersed himself in the ideas of object oriented programming. Like many of us, he gotten bitten by the design patterns bug and a copy of GOF is never far from his hands.

Now his primary interest is in creating a complete MIDI toolkit using the C# language. He hopes to create something that will become an indispensable tool for those wanting to write MIDI applications for the .NET framework.

Besides programming, his other interests are photography and playing his Les Paul guitars.

Comments and Discussions