Click here to Skip to main content
Click here to Skip to main content
Articles » Languages » C# » General » Downloads
 
Add your own
alternative version

A .NET State Machine Toolkit - Part III

, 26 Oct 2006 CPOL
Using code generation with the .NET state machine toolkit.
statemachinetoolkitpartiii_demo.zip
StateMachineToolkit
StateMachineBuilderDemo
App.ico
StateMachineBuilderDemo.csproj.user
StateMachineDemo
App.ico
StateMachineDemo.csproj.user
StateMachineMaker
App.ico
StateMachineMaker.csproj.user
StateMachineToolkit
bin
Debug
LSCollections.dll
CodeGeneration
StateMachineBuilder
StateMachineToolkit.csproj.user
statemachinetoolkitpartiii_src.zip
StateMachineToolkitPartIII_src
CodeGeneration
/*
 * Created by: Leslie Sanford
 * 
 * Contact: jabberdabber@hotmail.com
 * 
 * Last modified: 09/30/2005
 */

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

namespace StateMachineToolkit
{
	/// <summary>
	/// Builds the methods that make up the state machine.
	/// </summary>
	internal class MethodBuilder
	{
        #region MethodBuilder Members

        #region Fields

        private string initialState = string.Empty;

        // The state machine's states.
        private ICollection states;

        // The state machine's guards.
        private ICollection guards;

        // The state machine's actions.
        private ICollection actions;

        // Builds initializing methods.
        private InitializeMethodBuilder initializeMethodBuilder;        

        // The collection of built methods.
        private ArrayList methods = new ArrayList();

        #endregion

        #region Construction

        /// <summary>
        /// Initializes a new instance of the MethodBuilder class with all
        /// of the tables necessary to build the state machine methods.
        /// </summary>
        /// <param name="states">
        /// The state machine's states.
        /// </param>
        /// <param name="evets">
        /// The state machine's events.
        /// </param>
        /// <param name="guards">
        /// The state machine's guards.
        /// </param>
        /// <param name="actions">
        /// The state machine's actions.
        /// </param>
        /// <param name="stateTransitions">
        /// The state transitions.
        /// </param>
        /// <param name="stateRelationships">
        /// The substate/superstate relationships.
        /// </param>
        /// <param name="stateHistoryTypes">
        /// The state history types.
        /// </param>
        /// <param name="stateInitialStates">
        /// The states' initial states.
        /// </param>
		public MethodBuilder(ICollection states, ICollection events, 
            ICollection guards, ICollection actions, IDictionary stateTransitions,
            IDictionary stateRelationships, IDictionary stateHistoryTypes,
            IDictionary stateInitialStates)
		{
            this.states = states;
            this.guards = guards;
            this.actions = actions;
            
            initializeMethodBuilder = new InitializeMethodBuilder(states, events, 
                guards, actions, stateTransitions, stateRelationships, 
                stateHistoryTypes, stateInitialStates);
		}

        #endregion

        #region Methods

        /// <summary>
        /// Builds the methods for the state machine.
        /// </summary>
        public void Build()
        {
            methods = new ArrayList();

            // 
            // Builds initializing methods.
            //
           
            BuildInitializeMethod();
            initializeMethodBuilder.Build();
            methods.AddRange(initializeMethodBuilder.Result);

            //
            // Build entry and exit actions.
            //

            BuildMethods(states, "Entry", MemberAttributes.Family, null, 
                typeof(void));
            BuildMethods(states, "Exit", MemberAttributes.Family, null, 
                typeof(void));

            CodeParameterDeclarationExpression args = 
                new CodeParameterDeclarationExpression(typeof(object[]), "args");

            // Build guard methods.
            BuildMethods(guards, string.Empty, 
                MemberAttributes.Family | MemberAttributes.Abstract, args, 
                typeof(bool));

            // Build action methods.
            BuildMethods(actions, string.Empty,
                MemberAttributes.Family | MemberAttributes.Abstract, args, 
                typeof(void));            
        }

        // Builds methods.
        private void BuildMethods(ICollection col, string methodPrefix, 
            MemberAttributes attributes, 
            CodeParameterDeclarationExpression args, Type returnType)
        {
            CodeMemberMethod method;

            foreach(string name in col)
            {
                method = new CodeMemberMethod();
                method.Name = methodPrefix + name;
                method.Attributes = attributes;
                method.ReturnType = new CodeTypeReference(returnType);

                if(args != null)
                {
                    method.Parameters.Add(args);
                }

                methods.Add(method);
            }
        }

        // Builds the initialize method.
        private void BuildInitializeMethod()
        {
            CodeThisReferenceExpression thisReference = 
                new CodeThisReferenceExpression();
            CodeMemberMethod initializeMethod = new CodeMemberMethod();

            initializeMethod.Name = "Initialize";
            initializeMethod.Attributes = MemberAttributes.Private;

            CodeMethodInvokeExpression methodInvoke = new CodeMethodInvokeExpression();

            methodInvoke.Method.TargetObject = thisReference;
            methodInvoke.Method.MethodName = "InitializeStates";

            initializeMethod.Statements.Add(methodInvoke);

            methodInvoke = new CodeMethodInvokeExpression();

            methodInvoke.Method.TargetObject = thisReference;
            methodInvoke.Method.MethodName = "InitializeGuards";

            initializeMethod.Statements.Add(methodInvoke);

            methodInvoke = new CodeMethodInvokeExpression();

            methodInvoke.Method.TargetObject = thisReference;
            methodInvoke.Method.MethodName = "InitializeActions";

            initializeMethod.Statements.Add(methodInvoke);

            methodInvoke = new CodeMethodInvokeExpression();

            methodInvoke.Method.TargetObject = thisReference;
            methodInvoke.Method.MethodName = "InitializeTransitions";

            initializeMethod.Statements.Add(methodInvoke);

            methodInvoke = new CodeMethodInvokeExpression();

            methodInvoke.Method.TargetObject = thisReference;
            methodInvoke.Method.MethodName = "InitializeRelationships";

            initializeMethod.Statements.Add(methodInvoke);

            methodInvoke = new CodeMethodInvokeExpression();

            methodInvoke.Method.TargetObject = thisReference;
            methodInvoke.Method.MethodName = "InitializeHistoryTypes";

            initializeMethod.Statements.Add(methodInvoke);

            methodInvoke = new CodeMethodInvokeExpression();

            methodInvoke.Method.TargetObject = thisReference;
            methodInvoke.Method.MethodName = "InitializeInitialStates";

            initializeMethod.Statements.Add(methodInvoke);

            CodeExpression[] parameters = 
                {
                    new CodeFieldReferenceExpression(thisReference,
                    "state" + InitialState) 
                };

            CodeMethodInvokeExpression initializeInvoke = 
                new CodeMethodInvokeExpression(thisReference,
                "Initialize", parameters);

            initializeMethod.Statements.Add(initializeInvoke);

            methods.Add(initializeMethod);
        }

        #endregion

        #region Properties

        /// <summary>
        /// Gets the collection of built methods.
        /// </summary>
        public ICollection Result
        {
            get
            {
                return methods;
            }
        }

        /// <summary>
        /// Gets or sets the state machine's initial state.
        /// </summary>
        public string InitialState
        {
            get
            {
                return initialState;
            }
            set
            {
                initialState = value;
            }
        }

        #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)

Share

About the Author

Leslie Sanford

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.

| Advertise | Privacy | Terms of Use | Mobile
Web04 | 2.8.1411023.1 | Last Updated 26 Oct 2006
Article Copyright 2005 by Leslie Sanford
Everything else Copyright © CodeProject, 1999-2014
Layout: fixed | fluid