Chris@16: // Copyright 2008 Christophe Henry
Chris@16: // henry UNDERSCORE christophe AT hotmail DOT com
Chris@16: // This is an extended version of the state machine available in the boost::mpl library
Chris@16: // Distributed under the same license as the original.
Chris@16: // Copyright for the original version:
Chris@16: // Copyright 2005 David Abrahams and Aleksey Gurtovoy. Distributed
Chris@16: // under the Boost Software License, Version 1.0. (See accompanying
Chris@16: // file LICENSE_1_0.txt or copy at
Chris@16: // http://www.boost.org/LICENSE_1_0.txt)
Chris@16: 
Chris@16: #ifndef BOOST_MSM_FRONT_STATEMACHINE_DEF_H
Chris@16: #define BOOST_MSM_FRONT_STATEMACHINE_DEF_H
Chris@16: 
Chris@16: #include <exception>
Chris@16: #include <boost/assert.hpp>
Chris@16: 
Chris@16: #include <boost/mpl/vector.hpp>
Chris@16: 
Chris@16: #include <boost/msm/row_tags.hpp>
Chris@16: #include <boost/msm/back/common_types.hpp>
Chris@16: #include <boost/msm/front/states.hpp>
Chris@16: #include <boost/msm/front/completion_event.hpp>
Chris@16: #include <boost/msm/front/common_states.hpp>
Chris@16: 
Chris@16: namespace boost { namespace msm { namespace front
Chris@16: {
Chris@16: 
Chris@16: template<class Derived,class BaseState = default_base_state>
Chris@16: struct state_machine_def :  public boost::msm::front::detail::state_base<BaseState>
Chris@16: {
Chris@16:     // tags
Chris@16:     // default: no flag
Chris@16:     typedef ::boost::mpl::vector0<>               flag_list;
Chris@16:     typedef ::boost::mpl::vector0<>               internal_flag_list;
Chris@16:     //default: no deferred events
Chris@16:     typedef ::boost::mpl::vector0<>               deferred_events;
Chris@16:     // customization (message queue, exceptions)
Chris@16:     typedef ::boost::mpl::vector0<>               configuration;
Chris@16: 
Chris@16:     typedef BaseState                             BaseAllStates;
Chris@16:     template<
Chris@16:         typename T1
Chris@16:         , class Event
Chris@16:         , typename T2
Chris@16:         , void (Derived::*action)(Event const&)
Chris@16:     >
Chris@16:     struct a_row
Chris@16:     {
Chris@16:         typedef a_row_tag row_type_tag;
Chris@16:         typedef T1 Source;
Chris@16:         typedef T2 Target;
Chris@16:         typedef Event Evt;
Chris@16:         template <class FSM,class SourceState,class TargetState,class AllStates>
Chris@16:         static ::boost::msm::back::HandledEnum action_call(FSM& fsm,Event const& evt,SourceState&,TargetState&, AllStates&)
Chris@16:         {
Chris@16:             // in this front-end, we don't need to know source and target states
Chris@16:             (fsm.*action)(evt);
Chris@16:             return ::boost::msm::back::HANDLED_TRUE;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template<
Chris@16:         typename T1
Chris@16:         , class Event
Chris@16:         , typename T2
Chris@16:     >
Chris@16:     struct _row
Chris@16:     {
Chris@16:         typedef _row_tag row_type_tag;
Chris@16:         typedef T1 Source;
Chris@16:         typedef T2 Target;
Chris@16:         typedef Event Evt;
Chris@16:     };
Chris@16: 
Chris@16:     template<
Chris@16:         typename T1
Chris@16:         , class Event
Chris@16:         , typename T2
Chris@16:         , void (Derived::*action)(Event const&)
Chris@16:         , bool (Derived::*guard)(Event const&) 
Chris@16:     >
Chris@16:     struct row
Chris@16:     {
Chris@16:         typedef row_tag row_type_tag;
Chris@16:         typedef T1 Source;
Chris@16:         typedef T2 Target;
Chris@16:         typedef Event Evt;
Chris@16:         template <class FSM,class SourceState,class TargetState, class AllStates>
Chris@16:         static ::boost::msm::back::HandledEnum action_call(FSM& fsm,Event const& evt,SourceState&,TargetState&,AllStates&)
Chris@16:         {
Chris@16:             // in this front-end, we don't need to know source and target states
Chris@16:             (fsm.*action)(evt);
Chris@16:             return ::boost::msm::back::HANDLED_TRUE;
Chris@16:         }
Chris@16:         template <class FSM,class SourceState,class TargetState,class AllStates>
Chris@16:         static bool guard_call(FSM& fsm,Event const& evt,SourceState&,TargetState&,AllStates&)
Chris@16:         {
Chris@16:             // in this front-end, we don't need to know source and target states
Chris@16:             return (fsm.*guard)(evt);
Chris@16:         }
Chris@16:     };
Chris@16:     template<
Chris@16:         typename T1
Chris@16:         , class Event
Chris@16:         , typename T2
Chris@16:         , bool (Derived::*guard)(Event const&) 
Chris@16:     >
Chris@16:     struct g_row
Chris@16:     {
Chris@16:         typedef g_row_tag row_type_tag;
Chris@16:         typedef T1 Source;
Chris@16:         typedef T2 Target;
Chris@16:         typedef Event Evt;
Chris@16:         template <class FSM,class SourceState,class TargetState,class AllStates>
Chris@16:         static bool guard_call(FSM& fsm,Event const& evt,SourceState&,TargetState&,AllStates&)
Chris@16:         {
Chris@16:             // in this front-end, we don't need to know source and target states
Chris@16:             return (fsm.*guard)(evt);
Chris@16:         }
Chris@16:     };
Chris@16:     // internal transitions
Chris@16:     template<
Chris@16:         typename T1
Chris@16:         , class Event
Chris@16:         , void (Derived::*action)(Event const&)
Chris@16:     >
Chris@16:     struct a_irow
Chris@16:     {
Chris@16:         typedef a_irow_tag row_type_tag;
Chris@16:         typedef T1 Source;
Chris@16:         typedef T1 Target;
Chris@16:         typedef Event Evt;
Chris@16:         template <class FSM,class SourceState,class TargetState,class AllStates>
Chris@16:         static ::boost::msm::back::HandledEnum action_call(FSM& fsm,Event const& evt,SourceState&,TargetState&,AllStates&)
Chris@16:         {
Chris@16:             // in this front-end, we don't need to know source and target states
Chris@16:             (fsm.*action)(evt);
Chris@16:             return ::boost::msm::back::HANDLED_TRUE;
Chris@16:         }
Chris@16:     };
Chris@16: 
Chris@16:     template<
Chris@16:         typename T1
Chris@16:         , class Event
Chris@16:         , void (Derived::*action)(Event const&)
Chris@16:         , bool (Derived::*guard)(Event const&) 
Chris@16:     >
Chris@16:     struct irow
Chris@16:     {
Chris@16:         typedef irow_tag row_type_tag;
Chris@16:         typedef T1 Source;
Chris@16:         typedef T1 Target;
Chris@16:         typedef Event Evt;
Chris@16:         template <class FSM,class SourceState,class TargetState,class AllStates>
Chris@16:         static ::boost::msm::back::HandledEnum action_call(FSM& fsm,Event const& evt,SourceState&,TargetState&,AllStates&)
Chris@16:         {
Chris@16:             // in this front-end, we don't need to know source and target states
Chris@16:             (fsm.*action)(evt);
Chris@16:             return ::boost::msm::back::HANDLED_TRUE;
Chris@16:         }
Chris@16:         template <class FSM,class SourceState,class TargetState,class AllStates>
Chris@16:         static bool guard_call(FSM& fsm,Event const& evt,SourceState&,TargetState&,AllStates&)
Chris@16:         {
Chris@16:             // in this front-end, we don't need to know source and target states
Chris@16:             return (fsm.*guard)(evt);
Chris@16:         }
Chris@16:     };
Chris@16:     template<
Chris@16:         typename T1
Chris@16:         , class Event
Chris@16:         , bool (Derived::*guard)(Event const&) 
Chris@16:     >
Chris@16:     struct g_irow
Chris@16:     {
Chris@16:         typedef g_irow_tag row_type_tag;
Chris@16:         typedef T1 Source;
Chris@16:         typedef T1 Target;
Chris@16:         typedef Event Evt;
Chris@16:         template <class FSM,class SourceState,class TargetState,class AllStates>
Chris@16:         static bool guard_call(FSM& fsm,Event const& evt,SourceState&,TargetState&,AllStates&)
Chris@16:         {
Chris@16:             // in this front-end, we don't need to know source and target states
Chris@16:             return (fsm.*guard)(evt);
Chris@16:         }
Chris@16:     };
Chris@16:     // internal row withou action or guard. Does nothing except forcing the event to be ignored.
Chris@16:     template<
Chris@16:         typename T1
Chris@16:         , class Event
Chris@16:     >
Chris@16:     struct _irow
Chris@16:     {
Chris@16:         typedef _irow_tag row_type_tag;
Chris@16:         typedef T1 Source;
Chris@16:         typedef T1 Target;
Chris@16:         typedef Event Evt;
Chris@16:     };
Chris@16: protected:
Chris@16:     // Default no-transition handler. Can be replaced in the Derived SM class.
Chris@16:     template <class FSM,class Event>
Chris@16:     void no_transition(Event const& ,FSM&, int )
Chris@16:     {
Chris@16:         BOOST_ASSERT(false);
Chris@16:     }
Chris@16:     // default exception handler. Can be replaced in the Derived SM class.
Chris@16:     template <class FSM,class Event>
Chris@16:     void exception_caught (Event const&,FSM&,std::exception& )
Chris@16:     {
Chris@16:         BOOST_ASSERT(false);
Chris@16:     }
Chris@16: };
Chris@16: 
Chris@16: 
Chris@16: } } }// boost::msm::front
Chris@16: #endif //BOOST_MSM_FRONT_STATEMACHINE_DEF_H
Chris@16: