// Copyright 2008 Christophe Henry // henry UNDERSCORE christophe AT hotmail DOT com // This is an extended version of the state machine available in the boost::mpl library // Distributed under the same license as the original. // Copyright for the original version: // Copyright 2005 David Abrahams and Aleksey Gurtovoy. Distributed // under the Boost Software License, Version 1.0. (See accompanying // file LICENSE_1_0.txt or copy at // http://www.boost.org/LICENSE_1_0.txt) #ifndef BOOST_MSM_BACK_STATEMACHINE_H #define BOOST_MSM_BACK_STATEMACHINE_H #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #include #ifndef BOOST_NO_RTTI #include #endif #include #include #include #include #include #include #include #include #include #include #include #include #include #include BOOST_MPL_HAS_XXX_TRAIT_DEF(accept_sig) BOOST_MPL_HAS_XXX_TRAIT_DEF(no_automatic_create) BOOST_MPL_HAS_XXX_TRAIT_DEF(non_forwarding_flag) BOOST_MPL_HAS_XXX_TRAIT_DEF(direct_entry) BOOST_MPL_HAS_XXX_TRAIT_DEF(initial_event) BOOST_MPL_HAS_XXX_TRAIT_DEF(final_event) BOOST_MPL_HAS_XXX_TRAIT_DEF(do_serialize) BOOST_MPL_HAS_XXX_TRAIT_DEF(history_policy) BOOST_MPL_HAS_XXX_TRAIT_DEF(fsm_check) BOOST_MPL_HAS_XXX_TRAIT_DEF(compile_policy) BOOST_MPL_HAS_XXX_TRAIT_DEF(queue_container_policy) BOOST_MPL_HAS_XXX_TRAIT_DEF(using_declared_table) BOOST_MPL_HAS_XXX_TRAIT_DEF(event_queue_before_deferred_queue) #ifndef BOOST_MSM_CONSTRUCTOR_ARG_SIZE #define BOOST_MSM_CONSTRUCTOR_ARG_SIZE 5 // default max number of arguments for constructors #endif namespace boost { namespace msm { namespace back { // event used internally for wrapping a direct entry template struct direct_entry_event { typedef int direct_entry; typedef StateType active_state; typedef Event contained_event; direct_entry_event(Event const& evt):m_event(evt){} Event const& m_event; }; BOOST_PARAMETER_TEMPLATE_KEYWORD(front_end) BOOST_PARAMETER_TEMPLATE_KEYWORD(history_policy) BOOST_PARAMETER_TEMPLATE_KEYWORD(compile_policy) BOOST_PARAMETER_TEMPLATE_KEYWORD(fsm_check_policy) BOOST_PARAMETER_TEMPLATE_KEYWORD(queue_container_policy) typedef ::boost::parameter::parameters< ::boost::parameter::required< ::boost::msm::back::tag::front_end > , ::boost::parameter::optional< ::boost::parameter::deduced< ::boost::msm::back::tag::history_policy>, has_history_policy< ::boost::mpl::_ > > , ::boost::parameter::optional< ::boost::parameter::deduced< ::boost::msm::back::tag::compile_policy>, has_compile_policy< ::boost::mpl::_ > > , ::boost::parameter::optional< ::boost::parameter::deduced< ::boost::msm::back::tag::fsm_check_policy>, has_fsm_check< ::boost::mpl::_ > > , ::boost::parameter::optional< ::boost::parameter::deduced< ::boost::msm::back::tag::queue_container_policy>, has_queue_container_policy< ::boost::mpl::_ > > > state_machine_signature; // just here to disable use of proto when not needed template struct make_euml_terminal; template struct make_euml_terminal >::type> {}; template struct make_euml_terminal >::type> : public proto::extends::type, T, boost::msm::state_domain> {}; // library-containing class for state machines. Pass the actual FSM class as // the Concrete parameter. // A0=Derived,A1=NoHistory,A2=CompilePolicy,A3=FsmCheckPolicy > template < class A0 , class A1 = parameter::void_ , class A2 = parameter::void_ , class A3 = parameter::void_ , class A4 = parameter::void_ > class state_machine : //public Derived public ::boost::parameter::binding< typename state_machine_signature::bind::type, ::boost::msm::back::tag::front_end >::type , public make_euml_terminal, typename ::boost::parameter::binding< typename state_machine_signature::bind::type, ::boost::msm::back::tag::front_end >::type > { public: // Create ArgumentPack typedef typename state_machine_signature::bind::type state_machine_args; // Extract first logical parameter. typedef typename ::boost::parameter::binding< state_machine_args, ::boost::msm::back::tag::front_end>::type Derived; typedef typename ::boost::parameter::binding< state_machine_args, ::boost::msm::back::tag::history_policy, NoHistory >::type HistoryPolicy; typedef typename ::boost::parameter::binding< state_machine_args, ::boost::msm::back::tag::compile_policy, favor_runtime_speed >::type CompilePolicy; typedef typename ::boost::parameter::binding< state_machine_args, ::boost::msm::back::tag::fsm_check_policy, no_fsm_check >::type FsmCheckPolicy; typedef typename ::boost::parameter::binding< state_machine_args, ::boost::msm::back::tag::queue_container_policy, queue_container_deque >::type QueueContainerPolicy; private: typedef boost::msm::back::state_machine< A0,A1,A2,A3,A4> library_sm; typedef ::boost::function< execute_return ()> transition_fct; typedef ::boost::function< execute_return () > deferred_fct; typedef typename QueueContainerPolicy:: template In< std::pair >::type deferred_events_queue_t; typedef typename QueueContainerPolicy:: template In::type events_queue_t; typedef typename boost::mpl::eval_if< typename is_active_state_switch_policy::type, get_active_state_switch_policy, // default ::boost::mpl::identity >::type active_state_switching; typedef bool (*flag_handler)(library_sm const&); // all state machines are friend with each other to allow embedding any of them in another fsm template friend class boost::msm::back::state_machine; // helper to add, if needed, visitors to all states // version without visitors template struct visitor_fct_helper { public: visitor_fct_helper(){} void fill_visitors(int) { } template void insert(int,FCT) { } template void execute(int,VISITOR) { } }; // version with visitors template struct visitor_fct_helper >::type> { public: visitor_fct_helper():m_state_visitors(){} void fill_visitors(int number_of_states) { m_state_visitors.resize(number_of_states); } template void insert(int index,FCT fct) { m_state_visitors[index]=fct; } void execute(int index) { m_state_visitors[index](); } #define MSM_VISITOR_HELPER_EXECUTE_SUB(z, n, unused) ARG ## n vis ## n #define MSM_VISITOR_HELPER_EXECUTE(z, n, unused) \ template \ void execute(int index BOOST_PP_COMMA_IF(n) \ BOOST_PP_ENUM(n, MSM_VISITOR_HELPER_EXECUTE_SUB, ~ ) ) \ { \ m_state_visitors[index](BOOST_PP_ENUM_PARAMS(n,vis)); \ } BOOST_PP_REPEAT_FROM_TO(1,BOOST_PP_ADD(BOOST_MSM_VISITOR_ARG_SIZE,1), MSM_VISITOR_HELPER_EXECUTE, ~) #undef MSM_VISITOR_HELPER_EXECUTE #undef MSM_VISITOR_HELPER_EXECUTE_SUB private: typedef typename StateType::accept_sig::type visitor_fct; typedef std::vector visitors; visitors m_state_visitors; }; template struct deferred_msg_queue_helper { void clear(){} }; template struct deferred_msg_queue_helper::type,int >::type> { public: deferred_msg_queue_helper():m_deferred_events_queue(),m_cur_seq(0){} void clear() { m_deferred_events_queue.clear(); } deferred_events_queue_t m_deferred_events_queue; char m_cur_seq; }; public: // tags typedef int composite_tag; // in case someone needs to know typedef HistoryPolicy history_policy; struct InitEvent { }; struct ExitEvent { }; // flag handling struct Flag_AND { typedef std::logical_and type; }; struct Flag_OR { typedef std::logical_or type; }; typedef typename Derived::BaseAllStates BaseState; typedef Derived ConcreteSM; // if the front-end fsm provides an initial_event typedef, replace InitEvent by this one typedef typename ::boost::mpl::eval_if< typename has_initial_event::type, get_initial_event, ::boost::mpl::identity >::type fsm_initial_event; // if the front-end fsm provides an exit_event typedef, replace ExitEvent by this one typedef typename ::boost::mpl::eval_if< typename has_final_event::type, get_final_event, ::boost::mpl::identity >::type fsm_final_event; template struct exit_pt : public ExitPoint { // tags typedef ExitPoint wrapped_exit; typedef int pseudo_exit; typedef library_sm owner; typedef int no_automatic_create; typedef typename ExitPoint::event Event; typedef ::boost::function forwarding_function; // forward event to the higher-level FSM template void forward_event(ForwardEvent const& incomingEvent) { // use helper to forward or not ForwardHelper< ::boost::is_convertible::value>::helper(incomingEvent,m_forward); } void set_forward_fct(::boost::function fct) { m_forward = fct; } exit_pt():m_forward(){} // by assignments, we keep our forwarding functor unchanged as our containing SM did not change template exit_pt(RHS&):m_forward(){} exit_pt& operator= (const exit_pt& ) { return *this; } private: forwarding_function m_forward; // using partial specialization instead of enable_if because of VC8 bug template struct ForwardHelper { template static void helper(ForwardEvent const& ,forwarding_function& ) { // Not our event, assert BOOST_ASSERT(false); } }; template struct ForwardHelper { template static void helper(ForwardEvent const& incomingEvent,forwarding_function& forward_fct) { // call if handler set, if not, this state is simply a terminate state if (forward_fct) forward_fct(incomingEvent); } }; }; template struct entry_pt : public EntryPoint { // tags typedef EntryPoint wrapped_entry; typedef int pseudo_entry; typedef library_sm owner; typedef int no_automatic_create; }; template struct direct : public EntryPoint { // tags typedef EntryPoint wrapped_entry; typedef int explicit_entry_state; typedef library_sm owner; typedef int no_automatic_create; }; typedef typename get_number_of_regions::type nr_regions; // Template used to form rows in the transition table template< typename ROW > struct row_ { //typedef typename ROW::Source T1; typedef typename make_entry::type T1; typedef typename make_exit::type T2; typedef typename ROW::Evt transition_event; // if the source is an exit pseudo state, then // current_state_type becomes the result of get_owner // meaning the containing SM from which the exit occurs typedef typename ::boost::mpl::eval_if< typename has_pseudo_exit::type, get_owner, ::boost::mpl::identity >::type current_state_type; // if Target is a sequence, then we have a fork and expect a sequence of explicit_entry // else if Target is an explicit_entry, next_state_type becomes the result of get_owner // meaning the containing SM if the row is "outside" the containing SM or else the explicit_entry state itself typedef typename ::boost::mpl::eval_if< typename ::boost::mpl::is_sequence::type, get_fork_owner, ::boost::mpl::eval_if< typename has_no_automatic_create::type, get_owner, ::boost::mpl::identity > >::type next_state_type; // if a guard condition is here, call it to check that the event is accepted static bool check_guard(library_sm& fsm,transition_event const& evt) { if ( ROW::guard_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list ) ) return true; return false; } // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int region_index, int state, transition_event& evt) { BOOST_STATIC_CONSTANT(int, current_state = (get_state_id::type::value)); BOOST_STATIC_CONSTANT(int, next_state = (get_state_id::type::value)); boost::ignore_unused(state); // Avoid warnings if BOOST_ASSERT expands to nothing. BOOST_ASSERT(state == (current_state)); // if T1 is an exit pseudo state, then take the transition only if the pseudo exit state is active if (has_pseudo_exit::type::value && !is_exit_state_active >(fsm)) { return HANDLED_FALSE; } if (!check_guard(fsm,evt)) { // guard rejected the event, we stay in the current one return HANDLED_GUARD_REJECT; } fsm.m_states[region_index] = active_state_switching::after_guard(current_state,next_state); // the guard condition has already been checked execute_exit (::boost::fusion::at_key(fsm.m_substate_list),evt,fsm); fsm.m_states[region_index] = active_state_switching::after_exit(current_state,next_state); // then call the action method HandledEnum res = ROW::action_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list); fsm.m_states[region_index] = active_state_switching::after_action(current_state,next_state); // and finally the entry method of the new current state convert_event_and_execute_entry (::boost::fusion::at_key(fsm.m_substate_list),evt,fsm); fsm.m_states[region_index] = active_state_switching::after_entry(current_state,next_state); return res; } }; // row having only a guard condition template< typename ROW > struct g_row_ { //typedef typename ROW::Source T1; typedef typename make_entry::type T1; typedef typename make_exit::type T2; typedef typename ROW::Evt transition_event; // if the source is an exit pseudo state, then // current_state_type becomes the result of get_owner // meaning the containing SM from which the exit occurs typedef typename ::boost::mpl::eval_if< typename has_pseudo_exit::type, get_owner, ::boost::mpl::identity >::type current_state_type; // if Target is a sequence, then we have a fork and expect a sequence of explicit_entry // else if Target is an explicit_entry, next_state_type becomes the result of get_owner // meaning the containing SM if the row is "outside" the containing SM or else the explicit_entry state itself typedef typename ::boost::mpl::eval_if< typename ::boost::mpl::is_sequence::type, get_fork_owner, ::boost::mpl::eval_if< typename has_no_automatic_create::type, get_owner, ::boost::mpl::identity > >::type next_state_type; // if a guard condition is defined, call it to check that the event is accepted static bool check_guard(library_sm& fsm,transition_event const& evt) { if ( ROW::guard_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list )) return true; return false; } // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int region_index, int state, transition_event const& evt) { BOOST_STATIC_CONSTANT(int, current_state = (get_state_id::type::value)); BOOST_STATIC_CONSTANT(int, next_state = (get_state_id::type::value)); boost::ignore_unused(state); // Avoid warnings if BOOST_ASSERT expands to nothing. BOOST_ASSERT(state == (current_state)); // if T1 is an exit pseudo state, then take the transition only if the pseudo exit state is active if (has_pseudo_exit::type::value && !is_exit_state_active >(fsm)) { return HANDLED_FALSE; } if (!check_guard(fsm,evt)) { // guard rejected the event, we stay in the current one return HANDLED_GUARD_REJECT; } fsm.m_states[region_index] = active_state_switching::after_guard(current_state,next_state); // the guard condition has already been checked execute_exit (::boost::fusion::at_key(fsm.m_substate_list),evt,fsm); fsm.m_states[region_index] = active_state_switching::after_exit(current_state,next_state); fsm.m_states[region_index] = active_state_switching::after_action(current_state,next_state); // and finally the entry method of the new current state convert_event_and_execute_entry (::boost::fusion::at_key(fsm.m_substate_list),evt,fsm); fsm.m_states[region_index] = active_state_switching::after_entry(current_state,next_state); return HANDLED_TRUE; } }; // row having only an action method template< typename ROW > struct a_row_ { //typedef typename ROW::Source T1; typedef typename make_entry::type T1; typedef typename make_exit::type T2; typedef typename ROW::Evt transition_event; // if the source is an exit pseudo state, then // current_state_type becomes the result of get_owner // meaning the containing SM from which the exit occurs typedef typename ::boost::mpl::eval_if< typename has_pseudo_exit::type, get_owner, ::boost::mpl::identity >::type current_state_type; // if Target is a sequence, then we have a fork and expect a sequence of explicit_entry // else if Target is an explicit_entry, next_state_type becomes the result of get_owner // meaning the containing SM if the row is "outside" the containing SM or else the explicit_entry state itself typedef typename ::boost::mpl::eval_if< typename ::boost::mpl::is_sequence::type, get_fork_owner, ::boost::mpl::eval_if< typename has_no_automatic_create::type, get_owner, ::boost::mpl::identity > >::type next_state_type; // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int region_index, int state, transition_event& evt) { BOOST_STATIC_CONSTANT(int, current_state = (get_state_id::type::value)); BOOST_STATIC_CONSTANT(int, next_state = (get_state_id::type::value)); boost::ignore_unused(state); // Avoid warnings if BOOST_ASSERT expands to nothing. BOOST_ASSERT(state == (current_state)); // if T1 is an exit pseudo state, then take the transition only if the pseudo exit state is active if (has_pseudo_exit::type::value && !is_exit_state_active >(fsm)) { return HANDLED_FALSE; } fsm.m_states[region_index] = active_state_switching::after_guard(current_state,next_state); // no need to check the guard condition // first call the exit method of the current state execute_exit (::boost::fusion::at_key(fsm.m_substate_list),evt,fsm); fsm.m_states[region_index] = active_state_switching::after_exit(current_state,next_state); // then call the action method HandledEnum res = ROW::action_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list); fsm.m_states[region_index] = active_state_switching::after_action(current_state,next_state); // and finally the entry method of the new current state convert_event_and_execute_entry (::boost::fusion::at_key(fsm.m_substate_list),evt,fsm); fsm.m_states[region_index] = active_state_switching::after_entry(current_state,next_state); return res; } }; // row having no guard condition or action, simply transitions template< typename ROW > struct _row_ { //typedef typename ROW::Source T1; typedef typename make_entry::type T1; typedef typename make_exit::type T2; typedef typename ROW::Evt transition_event; // if the source is an exit pseudo state, then // current_state_type becomes the result of get_owner // meaning the containing SM from which the exit occurs typedef typename ::boost::mpl::eval_if< typename has_pseudo_exit::type, get_owner, ::boost::mpl::identity >::type current_state_type; // if Target is a sequence, then we have a fork and expect a sequence of explicit_entry // else if Target is an explicit_entry, next_state_type becomes the result of get_owner // meaning the containing SM if the row is "outside" the containing SM or else the explicit_entry state itself typedef typename ::boost::mpl::eval_if< typename ::boost::mpl::is_sequence::type, get_fork_owner, ::boost::mpl::eval_if< typename has_no_automatic_create::type, get_owner, ::boost::mpl::identity > >::type next_state_type; // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int region_index, int state, transition_event const& evt) { BOOST_STATIC_CONSTANT(int, current_state = (get_state_id::type::value)); BOOST_STATIC_CONSTANT(int, next_state = (get_state_id::type::value)); boost::ignore_unused(state); // Avoid warnings if BOOST_ASSERT expands to nothing. BOOST_ASSERT(state == (current_state)); // if T1 is an exit pseudo state, then take the transition only if the pseudo exit state is active if (has_pseudo_exit::type::value && !is_exit_state_active >(fsm)) { return HANDLED_FALSE; } fsm.m_states[region_index] = active_state_switching::after_guard(current_state,next_state); // first call the exit method of the current state execute_exit (::boost::fusion::at_key(fsm.m_substate_list),evt,fsm); fsm.m_states[region_index] = active_state_switching::after_exit(current_state,next_state); fsm.m_states[region_index] = active_state_switching::after_action(current_state,next_state); // and finally the entry method of the new current state convert_event_and_execute_entry (::boost::fusion::at_key(fsm.m_substate_list),evt,fsm); fsm.m_states[region_index] = active_state_switching::after_entry(current_state,next_state); return HANDLED_TRUE; } }; // "i" rows are rows for internal transitions template< typename ROW > struct irow_ { typedef typename make_entry::type T1; typedef typename make_exit::type T2; typedef typename ROW::Evt transition_event; typedef typename ROW::Source current_state_type; typedef T2 next_state_type; // if a guard condition is here, call it to check that the event is accepted static bool check_guard(library_sm& fsm,transition_event const& evt) { if ( ROW::guard_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list)) return true; return false; } // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int , int state, transition_event const& evt) { BOOST_STATIC_CONSTANT(int, current_state = (get_state_id::type::value)); boost::ignore_unused(state, current_state); // Avoid warnings if BOOST_ASSERT expands to nothing. BOOST_ASSERT(state == (current_state)); if (!check_guard(fsm,evt)) { // guard rejected the event, we stay in the current one return HANDLED_GUARD_REJECT; } // call the action method HandledEnum res = ROW::action_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list); return res; } }; // row having only a guard condition template< typename ROW > struct g_irow_ { typedef typename make_entry::type T1; typedef typename make_exit::type T2; typedef typename ROW::Evt transition_event; typedef typename ROW::Source current_state_type; typedef T2 next_state_type; // if a guard condition is defined, call it to check that the event is accepted static bool check_guard(library_sm& fsm,transition_event const& evt) { if ( ROW::guard_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list) ) return true; return false; } // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int , int state, transition_event const& evt) { BOOST_STATIC_CONSTANT(int, current_state = (get_state_id::type::value)); boost::ignore_unused(state, current_state); // Avoid warnings if BOOST_ASSERT expands to nothing. BOOST_ASSERT(state == (current_state)); if (!check_guard(fsm,evt)) { // guard rejected the event, we stay in the current one return HANDLED_GUARD_REJECT; } return HANDLED_TRUE; } }; // row having only an action method template< typename ROW > struct a_irow_ { typedef typename make_entry::type T1; typedef typename make_exit::type T2; typedef typename ROW::Evt transition_event; typedef typename ROW::Source current_state_type; typedef T2 next_state_type; // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int , int state, transition_event const& evt) { BOOST_STATIC_CONSTANT(int, current_state = (get_state_id::type::value)); boost::ignore_unused(state, current_state); // Avoid warnings if BOOST_ASSERT expands to nothing. BOOST_ASSERT(state == (current_state)); // call the action method HandledEnum res = ROW::action_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list); return res; } }; // row simply ignoring the event template< typename ROW > struct _irow_ { typedef typename make_entry::type T1; typedef typename make_exit::type T2; typedef typename ROW::Evt transition_event; typedef typename ROW::Source current_state_type; typedef T2 next_state_type; // Take the transition action and return the next state. static HandledEnum execute(library_sm& , int , int state, transition_event const& ) { BOOST_STATIC_CONSTANT(int, current_state = (get_state_id::type::value)); boost::ignore_unused(state, current_state); // Avoid warnings if BOOST_ASSERT expands to nothing. BOOST_ASSERT(state == (current_state)); return HANDLED_TRUE; } }; // transitions internal to this state machine (no substate involved) template< typename ROW, typename StateType > struct internal_ { typedef StateType current_state_type; typedef StateType next_state_type; typedef typename ROW::Evt transition_event; // if a guard condition is here, call it to check that the event is accepted static bool check_guard(library_sm& fsm,transition_event const& evt) { if ( ROW::guard_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list) ) return true; return false; } // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int , int , transition_event const& evt) { if (!check_guard(fsm,evt)) { // guard rejected the event, we stay in the current one return HANDLED_GUARD_REJECT; } // then call the action method HandledEnum res = ROW::action_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list); return res; } }; template< typename ROW > struct internal_ { typedef library_sm current_state_type; typedef library_sm next_state_type; typedef typename ROW::Evt transition_event; // if a guard condition is here, call it to check that the event is accepted static bool check_guard(library_sm& fsm,transition_event const& evt) { if ( ROW::guard_call(fsm,evt, fsm, fsm, fsm.m_substate_list) ) return true; return false; } // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int , int , transition_event const& evt) { if (!check_guard(fsm,evt)) { // guard rejected the event, we stay in the current one return HANDLED_GUARD_REJECT; } // then call the action method HandledEnum res = ROW::action_call(fsm,evt, fsm, fsm, fsm.m_substate_list); return res; } }; template< typename ROW, typename StateType > struct a_internal_ { typedef StateType current_state_type; typedef StateType next_state_type; typedef typename ROW::Evt transition_event; // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int, int, transition_event const& evt) { // then call the action method HandledEnum res = ROW::action_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list); return res; } }; template< typename ROW > struct a_internal_ { typedef library_sm current_state_type; typedef library_sm next_state_type; typedef typename ROW::Evt transition_event; // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int, int, transition_event const& evt) { // then call the action method HandledEnum res = ROW::action_call(fsm,evt, fsm, fsm, fsm.m_substate_list); return res; } }; template< typename ROW, typename StateType > struct g_internal_ { typedef StateType current_state_type; typedef StateType next_state_type; typedef typename ROW::Evt transition_event; // if a guard condition is here, call it to check that the event is accepted static bool check_guard(library_sm& fsm,transition_event const& evt) { if ( ROW::guard_call(fsm,evt, ::boost::fusion::at_key(fsm.m_substate_list), ::boost::fusion::at_key(fsm.m_substate_list), fsm.m_substate_list) ) return true; return false; } // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int, int, transition_event const& evt) { if (!check_guard(fsm,evt)) { // guard rejected the event, we stay in the current one return HANDLED_GUARD_REJECT; } return HANDLED_TRUE; } }; template< typename ROW > struct g_internal_ { typedef library_sm current_state_type; typedef library_sm next_state_type; typedef typename ROW::Evt transition_event; // if a guard condition is here, call it to check that the event is accepted static bool check_guard(library_sm& fsm,transition_event const& evt) { if ( ROW::guard_call(fsm,evt, fsm, fsm, fsm.m_substate_list) ) return true; return false; } // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int, int, transition_event const& evt) { if (!check_guard(fsm,evt)) { // guard rejected the event, we stay in the current one return HANDLED_GUARD_REJECT; } return HANDLED_TRUE; } }; template< typename ROW, typename StateType > struct _internal_ { typedef StateType current_state_type; typedef StateType next_state_type; typedef typename ROW::Evt transition_event; static HandledEnum execute(library_sm& , int , int , transition_event const& ) { return HANDLED_TRUE; } }; template< typename ROW > struct _internal_ { typedef library_sm current_state_type; typedef library_sm next_state_type; typedef typename ROW::Evt transition_event; static HandledEnum execute(library_sm& , int , int , transition_event const& ) { return HANDLED_TRUE; } }; // Template used to form forwarding rows in the transition table for every row of a composite SM template< typename T1 , class Evt > struct frow { typedef T1 current_state_type; typedef T1 next_state_type; typedef Evt transition_event; // tag to find out if a row is a forwarding row typedef int is_frow; // Take the transition action and return the next state. static HandledEnum execute(library_sm& fsm, int region_index, int , transition_event const& evt) { // false as second parameter because this event is forwarded from outer fsm execute_return res = (::boost::fusion::at_key(fsm.m_substate_list)).process_event_internal(evt); fsm.m_states[region_index]=get_state_id::type::value; return res; } // helper metafunctions used by dispatch table and give the frow a new event // (used to avoid double entries in a table because of base events) template struct replace_event { typedef frow type; }; }; template struct create_backend_stt { }; template struct create_backend_stt { typedef g_row_ type; }; template struct create_backend_stt { typedef a_row_ type; }; template struct create_backend_stt<_row_tag,Transition,StateType> { typedef _row_ type; }; template struct create_backend_stt { typedef row_ type; }; // internal transitions template struct create_backend_stt { typedef g_irow_ type; }; template struct create_backend_stt { typedef a_irow_ type; }; template struct create_backend_stt { typedef irow_ type; }; template struct create_backend_stt<_irow_tag,Transition,StateType> { typedef _irow_ type; }; template struct create_backend_stt { typedef a_internal_ type; }; template struct create_backend_stt { typedef g_internal_ type; }; template struct create_backend_stt { typedef internal_ type; }; template struct create_backend_stt { typedef _internal_ type; }; template struct make_row_tag { typedef typename create_backend_stt::type type; }; // add to the stt the initial states which could be missing (if not being involved in a transition) template struct create_real_stt { //typedef typename BaseType::transition_table stt_simulated; typedef typename ::boost::mpl::fold< stt_simulated,mpl::vector0<>, ::boost::mpl::push_back< ::boost::mpl::placeholders::_1, make_row_tag< ::boost::mpl::placeholders::_2 , BaseType > > >::type type; }; template struct add_forwarding_row_helper { typedef typename generate_event_set::type all_events; typedef typename ::boost::mpl::fold< all_events, Intermediate, ::boost::mpl::push_back< ::boost::mpl::placeholders::_1, frow > >::type type; }; // gets the transition table from a composite and make from it a forwarding row template struct get_internal_transition_table { // first get the table of a composite typedef typename recursive_get_transition_table::type original_table; // we now look for the events the composite has in its internal transitions // the internal ones are searched recursively in sub-sub... states // we go recursively because our states can also have internal tables or substates etc. typedef typename recursive_get_internal_transition_table::type recursive_istt; typedef typename ::boost::mpl::fold< recursive_istt,::boost::mpl::vector0<>, ::boost::mpl::push_back< ::boost::mpl::placeholders::_1, make_row_tag< ::boost::mpl::placeholders::_2 , StateType> > >::type recursive_istt_with_tag; typedef typename ::boost::mpl::insert_range< original_table, typename ::boost::mpl::end::type, recursive_istt_with_tag>::type table_with_all_events; // and add for every event a forwarding row typedef typename ::boost::mpl::eval_if< typename CompilePolicy::add_forwarding_rows, add_forwarding_row_helper,StateType>, ::boost::mpl::identity< ::boost::mpl::vector0<> > >::type type; }; template struct get_internal_transition_table { typedef typename create_real_stt::type type; }; // typedefs used internally typedef typename create_real_stt::type real_transition_table; typedef typename create_stt::type stt; typedef typename get_initial_states::type initial_states; typedef typename generate_state_set::type state_list; typedef typename HistoryPolicy::template apply::type concrete_history; typedef typename ::boost::fusion::result_of::as_set::type substate_list; typedef typename ::boost::msm::back::generate_event_set< typename create_real_stt::type >::type processable_events_internal_table; // extends the transition table with rows from composite states template struct extend_table { // add the init states //typedef typename create_stt::type stt; typedef typename Composite::stt Stt; // add the internal events defined in the internal_transition_table // Note: these are added first because they must have a lesser prio // than the deeper transitions in the sub regions // table made of a stt + internal transitions of composite typedef typename ::boost::mpl::fold< typename Composite::internal_transition_table,::boost::mpl::vector0<>, ::boost::mpl::push_back< ::boost::mpl::placeholders::_1, make_row_tag< ::boost::mpl::placeholders::_2 , Composite> > >::type internal_stt; typedef typename ::boost::mpl::insert_range< Stt, typename ::boost::mpl::end::type, internal_stt //typename get_internal_transition_table::type >::type stt_plus_internal; // for every state, add its transition table (if any) // transformed as frow typedef typename ::boost::mpl::fold, get_internal_transition_table< ::boost::mpl::placeholders::_2, is_composite_state< ::boost::mpl::placeholders::_2> > > >::type type; }; // extend the table with tables from composite states typedef typename extend_table::type complete_table; // build a sequence of regions typedef typename get_regions_as_sequence::type seq_initial_states; // Member functions // start the state machine (calls entry of the initial state) void start() { // reinitialize our list of currently active states with the ones defined in Derived::initial_state ::boost::mpl::for_each< seq_initial_states, ::boost::msm::wrap > (init_states(m_states)); // call on_entry on this SM (static_cast(this))->on_entry(fsm_initial_event(),*this); ::boost::mpl::for_each > (call_init(fsm_initial_event(),this)); // give a chance to handle an anonymous (eventless) transition handle_eventless_transitions_helper eventless_helper(this,true); eventless_helper.process_completion_event(); } // start the state machine (calls entry of the initial state passing incomingEvent to on_entry's) template void start(Event const& incomingEvent) { // reinitialize our list of currently active states with the ones defined in Derived::initial_state ::boost::mpl::for_each< seq_initial_states, ::boost::msm::wrap > (init_states(m_states)); // call on_entry on this SM (static_cast(this))->on_entry(incomingEvent,*this); ::boost::mpl::for_each > (call_init(incomingEvent,this)); // give a chance to handle an anonymous (eventless) transition handle_eventless_transitions_helper eventless_helper(this,true); eventless_helper.process_completion_event(); } // stop the state machine (calls exit of the current state) void stop() { do_exit(fsm_final_event(),*this); } // stop the state machine (calls exit of the current state passing finalEvent to on_exit's) template void stop(Event const& finalEvent) { do_exit(finalEvent,*this); } // Main function used by clients of the derived FSM to make transitions. template execute_return process_event(Event const& evt) { return process_event_internal(evt, EVENT_SOURCE_DIRECT); } template void enqueue_event_helper(EventType const& evt, ::boost::mpl::false_ const &) { execute_return (library_sm::*pf) (EventType const&, EventSource) = &library_sm::process_event_internal; m_events_queue.m_events_queue.push_back( ::boost::bind( pf, this, evt, static_cast(EVENT_SOURCE_MSG_QUEUE))); } template void enqueue_event_helper(EventType const& , ::boost::mpl::true_ const &) { // no queue } void execute_queued_events_helper(::boost::mpl::false_ const &) { while(!m_events_queue.m_events_queue.empty()) { transition_fct to_call = m_events_queue.m_events_queue.front(); m_events_queue.m_events_queue.pop_front(); to_call(); } } void execute_queued_events_helper(::boost::mpl::true_ const &) { // no queue required } void execute_single_queued_event_helper(::boost::mpl::false_ const &) { transition_fct to_call = m_events_queue.m_events_queue.front(); m_events_queue.m_events_queue.pop_front(); to_call(); } void execute_single_queued_event_helper(::boost::mpl::true_ const &) { // no queue required } // enqueues an event in the message queue // call execute_queued_events to process all queued events. // Be careful if you do this during event processing, the event will be processed immediately // and not kept in the queue template void enqueue_event(EventType const& evt) { enqueue_event_helper(evt, typename is_no_message_queue::type()); } // empty the queue and process events void execute_queued_events() { execute_queued_events_helper(typename is_no_message_queue::type()); } void execute_single_queued_event() { execute_single_queued_event_helper(typename is_no_message_queue::type()); } typename events_queue_t::size_type get_message_queue_size() const { return m_events_queue.m_events_queue.size(); } events_queue_t& get_message_queue() { return m_events_queue.m_events_queue; } const events_queue_t& get_message_queue() const { return m_events_queue.m_events_queue; } void clear_deferred_queue() { m_deferred_events_queue.clear(); } deferred_events_queue_t& get_deferred_queue() { return m_deferred_events_queue.m_deferred_events_queue; } const deferred_events_queue_t& get_deferred_queue() const { return m_deferred_events_queue.m_deferred_events_queue; } // Getter that returns the current state of the FSM const int* current_state() const { return this->m_states; } template struct serialize_state { serialize_state(Archive& ar):ar_(ar){} template typename ::boost::enable_if< typename ::boost::mpl::or_< typename has_do_serialize::type, typename is_composite_state::type >::type ,void >::type operator()(T& t) const { ar_ & t; } template typename ::boost::disable_if< typename ::boost::mpl::or_< typename has_do_serialize::type, typename is_composite_state::type >::type ,void >::type operator()(T&) const { // no state to serialize } Archive& ar_; }; template void serialize(Archive & ar, const unsigned int) { // invoke serialization of the base class (serialize_state(ar))(boost::serialization::base_object(*this)); // now our attributes ar & m_states; // queues cannot be serialized => skip ar & m_history; ar & m_event_processing; ar & m_is_included; // visitors cannot be serialized => skip ::boost::fusion::for_each(m_substate_list, serialize_state(ar)); } // linearly search for the state with the given id struct get_state_id_helper { get_state_id_helper(int id,const BaseState** res,const library_sm* self_): result_state(res),searched_id(id),self(self_) {} template void operator()(boost::msm::wrap const&) { // look for the state id until found BOOST_STATIC_CONSTANT(int, id = (get_state_id::value)); if (!*result_state && (id == searched_id)) { *result_state = &::boost::fusion::at_key(self->m_substate_list); } } const BaseState** result_state; int searched_id; const library_sm* self; }; // return the state whose id is passed or 0 if not found // caution if you need this, you probably need polymorphic states // complexity: O(number of states) BaseState* get_state_by_id(int id) { const BaseState* result_state=0; ::boost::mpl::for_each > (get_state_id_helper(id,&result_state,this)); return const_cast(result_state); } const BaseState* get_state_by_id(int id) const { const BaseState* result_state=0; ::boost::mpl::for_each > (get_state_id_helper(id,&result_state,this)); return result_state; } // true if the sm is used in another sm bool is_contained() const { return m_is_included; } // get the history policy class concrete_history& get_history() { return m_history; } concrete_history const& get_history() const { return m_history; } // get a state (const version) // as a pointer template typename ::boost::enable_if::type,State >::type get_state(::boost::msm::back::dummy<0> = 0) const { return const_cast (& (::boost::fusion::at_key< typename ::boost::remove_const::type>::type>(m_substate_list))); } // as a reference template typename ::boost::enable_if::type,State >::type get_state(::boost::msm::back::dummy<1> = 0) const { return const_cast ( ::boost::fusion::at_key< typename ::boost::remove_const::type>::type>(m_substate_list) ); } // get a state (non const version) // as a pointer template typename ::boost::enable_if::type,State >::type get_state(::boost::msm::back::dummy<0> = 0) { return &(static_cast::type>::type > (::boost::fusion::at_key::type>(m_substate_list))); } // as a reference template typename ::boost::enable_if::type,State >::type get_state(::boost::msm::back::dummy<1> = 0) { return ::boost::fusion::at_key::type>(m_substate_list); } // checks if a flag is active using the BinaryOp as folding function template bool is_flag_active() const { flag_handler* flags_entries = get_entries_for_flag(); bool res = (*flags_entries[ m_states[0] ])(*this); for (int i = 1; i < nr_regions::value ; ++i) { res = typename BinaryOp::type() (res,(*flags_entries[ m_states[i] ])(*this)); } return res; } // checks if a flag is active using no binary op if 1 region, or OR if > 1 regions template bool is_flag_active() const { return FlagHelper1)>::helper(*this,get_entries_for_flag()); } // visit the currently active states (if these are defined as visitable // by implementing accept) void visit_current_states() { for (int i=0; i \ void visit_current_states(BOOST_PP_ENUM(n, MSM_VISIT_STATE_SUB, ~ ) ) \ { \ for (int i=0; i typename::boost::disable_if< typename ::boost::msm::is_kleene_event::type, void>::type defer_event(Event const& e) { // to call this function, you need either a state with a deferred_events typedef // or that the fsm provides the activate_deferred_events typedef BOOST_MPL_ASSERT(( has_fsm_deferred_events )); execute_return (library_sm::*pf) (Event const&, EventSource) = &library_sm::process_event_internal; // Deferred events are added with a correlation sequence that helps to // identify when an event was added - This is typically to distinguish // between events deferred in this processing versus previous. m_deferred_events_queue.m_deferred_events_queue.push_back( std::make_pair( ::boost::bind( pf, this, e, static_cast(EVENT_SOURCE_DIRECT|EVENT_SOURCE_DEFERRED)), static_cast(m_deferred_events_queue.m_cur_seq+1))); } protected: template struct defer_event_kleene_helper { defer_event_kleene_helper(KleeneEvent const& e, Fsm* fsm, bool& found) : m_event(e), m_fsm(fsm), m_found(found) {} // History initializer function object, used with mpl::for_each template void operator()(Event const& ev) { if (m_event.type() == boost::typeindex::type_id().type_info()) { m_found = true; // to call this function, you need either a state with a deferred_events typedef // or that the fsm provides the activate_deferred_events typedef BOOST_MPL_ASSERT((has_fsm_deferred_events)); ::boost::msm::back::execute_return(library_sm:: * pf) (Event const&, ::boost::msm::back::EventSource) = &library_sm::process_event_internal; // Deferred events are added with a correlation sequence that helps to // identify when an event was added - This is typically to distinguish // between events deferred in this processing versus previous. m_fsm->m_deferred_events_queue.m_deferred_events_queue.push_back( std::make_pair( ::boost::bind( pf, m_fsm, boost::any_cast(m_event), static_cast<::boost::msm::back::EventSource>(::boost::msm::back::EVENT_SOURCE_DIRECT | ::boost::msm::back::EVENT_SOURCE_DEFERRED)), static_cast(m_fsm->m_deferred_events_queue.m_cur_seq + 1))); } } KleeneEvent const& m_event; Fsm* m_fsm; bool& m_found; }; public: template typename::boost::enable_if< typename ::boost::msm::is_kleene_event::type, void>::type defer_event(Event const& e) { typedef typename generate_event_set::type event_list; bool found = false; boost::fusion::for_each( event_list(), defer_event_kleene_helper(e,this,found)); if (!found) { for (int i = 0; i < nr_regions::value; ++i) { this->no_transition(e, *this, this->m_states[i]); } } } protected: // interface for the derived class // helper used to fill the initial states struct init_states { init_states(int* const init):m_initial_states(init),m_index(-1){} // History initializer function object, used with mpl::for_each template void operator()(::boost::msm::wrap const&) { m_initial_states[++m_index]=get_state_id::type::value; } int* const m_initial_states; int m_index; }; public: struct update_state { update_state(substate_list& to_overwrite_):to_overwrite(&to_overwrite_){} template void operator()(StateType const& astate) const { ::boost::fusion::at_key(*to_overwrite)=astate; } substate_list* to_overwrite; }; template void set_states(Expr const& expr) { ::boost::fusion::for_each( ::boost::fusion::as_vector(FoldToList()(expr, boost::fusion::nil_())),update_state(this->m_substate_list)); } // Construct with the default initial states state_machine() :Derived() ,m_events_queue() ,m_deferred_events_queue() ,m_history() ,m_event_processing(false) ,m_is_included(false) ,m_visitors() ,m_substate_list() { // initialize our list of states with the ones defined in Derived::initial_state ::boost::mpl::for_each< seq_initial_states, ::boost::msm::wrap > (init_states(m_states)); m_history.set_initial_states(m_states); // create states fill_states(this); } // Construct with the default initial states and some default argument(s) #if defined (BOOST_NO_CXX11_RVALUE_REFERENCES) \ || defined (BOOST_NO_CXX11_VARIADIC_TEMPLATES) \ || defined (BOOST_NO_CXX11_FUNCTION_TEMPLATE_DEFAULT_ARGS) template state_machine (Expr const& expr, typename ::boost::enable_if::type >::type* = 0) :Derived() , m_events_queue() , m_deferred_events_queue() , m_history() , m_event_processing(false) , m_is_included(false) , m_visitors() , m_substate_list() { BOOST_MPL_ASSERT_MSG( (::boost::proto::matches::value), THE_STATES_EXPRESSION_PASSED_DOES_NOT_MATCH_GRAMMAR, (FoldToList)); // initialize our list of states with the ones defined in Derived::initial_state ::boost::mpl::for_each< seq_initial_states, ::boost::msm::wrap > (init_states(m_states)); m_history.set_initial_states(m_states); // create states set_states(expr); fill_states(this); } #define MSM_CONSTRUCTOR_HELPER_EXECUTE_SUB(z, n, unused) ARG ## n t ## n #define MSM_CONSTRUCTOR_HELPER_EXECUTE(z, n, unused) \ template \ state_machine(BOOST_PP_ENUM(n, MSM_CONSTRUCTOR_HELPER_EXECUTE_SUB, ~ ), \ typename ::boost::disable_if::type >::type* =0 ) \ :Derived(BOOST_PP_ENUM_PARAMS(n,t)) \ ,m_events_queue() \ ,m_deferred_events_queue() \ ,m_history() \ ,m_event_processing(false) \ ,m_is_included(false) \ ,m_visitors() \ ,m_substate_list() \ { \ ::boost::mpl::for_each< seq_initial_states, ::boost::msm::wrap > \ (init_states(m_states)); \ m_history.set_initial_states(m_states); \ fill_states(this); \ } \ template \ state_machine(Expr const& expr,BOOST_PP_ENUM(n, MSM_CONSTRUCTOR_HELPER_EXECUTE_SUB, ~ ), \ typename ::boost::enable_if::type >::type* =0 ) \ :Derived(BOOST_PP_ENUM_PARAMS(n,t)) \ ,m_events_queue() \ ,m_deferred_events_queue() \ ,m_history() \ ,m_event_processing(false) \ ,m_is_included(false) \ ,m_visitors() \ ,m_substate_list() \ { \ BOOST_MPL_ASSERT_MSG( \ ( ::boost::proto::matches::value), \ THE_STATES_EXPRESSION_PASSED_DOES_NOT_MATCH_GRAMMAR, \ (FoldToList)); \ ::boost::mpl::for_each< seq_initial_states, ::boost::msm::wrap > \ (init_states(m_states)); \ m_history.set_initial_states(m_states); \ set_states(expr); \ fill_states(this); \ } BOOST_PP_REPEAT_FROM_TO(1,BOOST_PP_ADD(BOOST_MSM_CONSTRUCTOR_ARG_SIZE,1), MSM_CONSTRUCTOR_HELPER_EXECUTE, ~) #undef MSM_CONSTRUCTOR_HELPER_EXECUTE #undef MSM_CONSTRUCTOR_HELPER_EXECUTE_SUB #else template ::type >::type> state_machine(ARG0&& t0,ARG&&... t) :Derived(std::forward(t0), std::forward(t)...) ,m_events_queue() ,m_deferred_events_queue() ,m_history() ,m_event_processing(false) ,m_is_included(false) ,m_visitors() ,m_substate_list() { ::boost::mpl::for_each< seq_initial_states, ::boost::msm::wrap > (init_states(m_states)); m_history.set_initial_states(m_states); fill_states(this); } template ::type >::type> state_machine(Expr const& expr,ARG&&... t) :Derived(std::forward(t)...) ,m_events_queue() ,m_deferred_events_queue() ,m_history() ,m_event_processing(false) ,m_is_included(false) ,m_visitors() ,m_substate_list() { BOOST_MPL_ASSERT_MSG( ( ::boost::proto::matches::value), THE_STATES_EXPRESSION_PASSED_DOES_NOT_MATCH_GRAMMAR, (FoldToList)); ::boost::mpl::for_each< seq_initial_states, ::boost::msm::wrap > (init_states(m_states)); m_history.set_initial_states(m_states); set_states(expr); fill_states(this); } #endif // assignment operator using the copy policy to decide if non_copyable, shallow or deep copying is necessary library_sm& operator= (library_sm const& rhs) { if (this != &rhs) { Derived::operator=(rhs); do_copy(rhs); } return *this; } state_machine(library_sm const& rhs) : Derived(rhs) { if (this != &rhs) { // initialize our list of states with the ones defined in Derived::initial_state fill_states(this); do_copy(rhs); } } // the following 2 functions handle the terminate/interrupt states handling // if one of these states is found, the first one is used template bool is_event_handling_blocked_helper( ::boost::mpl::true_ const &) { // if the state machine is terminated, do not handle any event if (is_flag_active< ::boost::msm::TerminateFlag>()) return true; // if the state machine is interrupted, do not handle any event // unless the event is the end interrupt event if ( is_flag_active< ::boost::msm::InterruptedFlag>() && !is_flag_active< ::boost::msm::EndInterruptFlag >()) return true; return false; } // otherwise simple handling, no flag => continue template bool is_event_handling_blocked_helper( ::boost::mpl::false_ const &) { // no terminate/interrupt states detected return false; } void do_handle_prio_msg_queue_deferred_queue(EventSource source, HandledEnum handled, ::boost::mpl::true_ const &) { // non-default. Handle msg queue with higher prio than deferred queue if (!(EVENT_SOURCE_MSG_QUEUE & source)) { do_post_msg_queue_helper( ::boost::mpl::bool_< is_no_message_queue::type::value>()); if (!(EVENT_SOURCE_DEFERRED & source)) { handle_defer_helper defer_helper(m_deferred_events_queue); defer_helper.do_handle_deferred(HANDLED_TRUE & handled); } } } void do_handle_prio_msg_queue_deferred_queue(EventSource source, HandledEnum handled, ::boost::mpl::false_ const &) { // default. Handle deferred queue with higher prio than msg queue if (!(EVENT_SOURCE_DEFERRED & source)) { handle_defer_helper defer_helper(m_deferred_events_queue); defer_helper.do_handle_deferred(HANDLED_TRUE & handled); // Handle any new events generated into the queue, but only if // we're not already processing from the message queue. if (!(EVENT_SOURCE_MSG_QUEUE & source)) { do_post_msg_queue_helper( ::boost::mpl::bool_< is_no_message_queue::type::value>()); } } } // the following functions handle pre/post-process handling of a message queue template bool do_pre_msg_queue_helper(EventType const&, ::boost::mpl::true_ const &) { // no message queue needed return true; } template bool do_pre_msg_queue_helper(EventType const& evt, ::boost::mpl::false_ const &) { execute_return (library_sm::*pf) (EventType const&, EventSource) = &library_sm::process_event_internal; // if we are already processing an event if (m_event_processing) { // event has to be put into the queue m_events_queue.m_events_queue.push_back( ::boost::bind( pf, this, evt, static_cast(EVENT_SOURCE_DIRECT | EVENT_SOURCE_MSG_QUEUE))); return false; } // event can be handled, processing m_event_processing = true; return true; } void do_post_msg_queue_helper( ::boost::mpl::true_ const &) { // no message queue needed } void do_post_msg_queue_helper( ::boost::mpl::false_ const &) { process_message_queue(this); } void do_allow_event_processing_after_transition( ::boost::mpl::true_ const &) { // no message queue needed } void do_allow_event_processing_after_transition( ::boost::mpl::false_ const &) { m_event_processing = false; } // the following 2 functions handle the processing either with a try/catch protection or without template HandledEnum do_process_helper(EventType const& evt, ::boost::mpl::true_ const &, bool is_direct_call) { return this->do_process_event(evt,is_direct_call); } template HandledEnum do_process_helper(EventType const& evt, ::boost::mpl::false_ const &, bool is_direct_call) { // when compiling without exception support there is no formal parameter "e" in the catch handler. // Declaring a local variable here does not hurt and will be "used" to make the code in the handler // compilable although the code will never be executed. std::exception e; BOOST_TRY { return this->do_process_event(evt,is_direct_call); } BOOST_CATCH (std::exception& e) { // give a chance to the concrete state machine to handle this->exception_caught(evt,*this,e); return ::boost::msm::back::HANDLED_FALSE; } BOOST_CATCH_END return HANDLED_TRUE; } // handling of deferred events // if none is found in the SM, take the following empty main version template struct handle_defer_helper { handle_defer_helper(deferred_msg_queue_helper& ){} void do_handle_deferred(bool) { } }; // otherwise the standard version handling the deferred events template struct handle_defer_helper ::type,int >::type> { struct sort_greater { bool operator()( typename deferred_events_queue_t::value_type const& d1, typename deferred_events_queue_t::value_type const& d2) { return d1.second > d2.second; } }; struct set_sequence { set_sequence(char s) :seq_(s) {} void operator()(typename deferred_events_queue_t::value_type& d) { d.second = seq_; } char seq_; }; handle_defer_helper(deferred_msg_queue_helper& a_queue): m_events_queue(a_queue) {} void do_handle_deferred(bool new_seq=false) { // A new sequence is typically started upon initial entry to the // state, or upon a new transition. When this occurs we want to // process all previously deferred events by incrementing the // correlation sequence. if (new_seq) { ++m_events_queue.m_cur_seq; } char& cur_seq = m_events_queue.m_cur_seq; // Iteratively process all of the events within the deferred // queue upto (but not including) newly deferred events. // if we did not defer one in the queue, then we need to try again bool not_only_deferred = false; while (!m_events_queue.m_deferred_events_queue.empty()) { typename deferred_events_queue_t::value_type& pair = m_events_queue.m_deferred_events_queue.front(); if (cur_seq != pair.second) { break; } deferred_fct next = pair.first; m_events_queue.m_deferred_events_queue.pop_front(); boost::msm::back::execute_return res = next(); if (res != ::boost::msm::back::HANDLED_FALSE && res != ::boost::msm::back::HANDLED_DEFERRED) { not_only_deferred = true; } if (not_only_deferred) { // handled one, stop processing deferred until next block reorders break; } } if (not_only_deferred) { // attempt to go back to the situation prior to processing, // in case some deferred events would have been re-queued // in that case those would have a higher sequence number std::stable_sort( m_events_queue.m_deferred_events_queue.begin(), m_events_queue.m_deferred_events_queue.end(), sort_greater() ); // reset sequence number for all std::for_each( m_events_queue.m_deferred_events_queue.begin(), m_events_queue.m_deferred_events_queue.end(), set_sequence(m_events_queue.m_cur_seq + 1) ); // one deferred event was successfully processed, try again do_handle_deferred(true); } } private: deferred_msg_queue_helper& m_events_queue; }; // handling of eventless transitions // if none is found in the SM, nothing to do template struct handle_eventless_transitions_helper { handle_eventless_transitions_helper(library_sm* , bool ){} void process_completion_event(EventSource = EVENT_SOURCE_DEFAULT){} }; // otherwise template struct handle_eventless_transitions_helper ::type >::type> { handle_eventless_transitions_helper(library_sm* self_, bool handled_):self(self_),handled(handled_){} void process_completion_event(EventSource source = EVENT_SOURCE_DEFAULT) { typedef typename ::boost::mpl::deref< typename ::boost::mpl::begin< typename find_completion_events::type >::type >::type first_completion_event; if (handled) { self->process_event_internal( first_completion_event(), source | EVENT_SOURCE_DIRECT); } } private: library_sm* self; bool handled; }; // helper class called in case the event to process has been found in the fsm's internal stt and is therefore processable template struct process_fsm_internal_table { typedef typename ::boost::mpl::has_key