nz_menuFsm.h

Go to the documentation of this file.

 /*********************************************************************
 * @section nz_menuFsm_lic Software License Agreement
 *
 * The software supplied herewith is owned by Modtronix Engineering, and is
 * protected under applicable copyright laws. The software supplied herewith is
 * intended and supplied to you, the Company customer, for use solely and
 * exclusively on products manufactured by Modtronix Engineering. The code may
 * be modified and can be used free of charge for commercial and non commercial
 * applications. All rights are reserved. Any use in violation of the foregoing
 * restrictions may subject the user to criminal sanctions under applicable laws,
 * as well as to civil liability for the breach of the terms and conditions of this license.
 *
 * THIS SOFTWARE IS PROVIDED IN AN 'AS IS' CONDITION. NO WARRANTIES, WHETHER EXPRESS,
 * IMPLIED OR STATUTORY, INCLUDING, BUT NOT LIMITED TO, IMPLIED WARRANTIES OF
 * MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE APPLY TO THIS SOFTWARE. THE
 * COMPANY SHALL NOT, IN ANY CIRCUMSTANCES, BE LIABLE FOR SPECIAL, INCIDENTAL OR
 * CONSEQUENTIAL DAMAGES, FOR ANY REASON WHATSOEVER.
 **********************************************************************
 * File History
 *
 * 2005-10-06, David Hosken (DH):
 *    - Initial version
 *********************************************************************/

#ifndef _fsmMenu_H_
#define _fsmMenu_H_

typedef struct _FSM {
    uint8_t stateTop;   //Current state
    uint8_t stateSub1;  //State of sub1 Sub Menu, 0 means it is disabled
    uint8_t action;     //Current action -  is a SMT_ACTION_XXX define
} FSM;

#define FSM_ACTION_ENTRY   0    //Action to take when entering the state
#define FSM_ACTION_EXIT    1    //Action to take when existing the state
#define FSM_ACTION_INPUT   2    //Execute the action dependent on present state and input conditions. Will normally spend most time in this state!
#define FSM_ACTION_TRANS   3    //Execute the action when performing a certain transition

#define fsmSetAction2Entry(sm) {sm.action = FSM_ACTION_ENTRY;}

#define fsmSetAction2Exit(sm) {sm.action = FSM_ACTION_EXIT;}

#define fsmSetAction2Input(sm) {sm.action = FSM_ACTION_INPUT;}

#define fsmSetAction2Transition(sm) {sm.action = FSM_ACTION_TRANS;}

#define fsmSetState(sm, newState) {sm.stateTop=newState; sm.stateSub1=0; sm.action=FSM_ACTION_ENTRY;}

#define fsmIncState(sm, lastState) { (sm.stateTop==lastState) ? sm.stateTop=0 : sm.stateTop++; sm.stateSub1=0; sm.action=FSM_ACTION_ENTRY;}

#define fsmDecState(sm, lastState) { (sm.stateTop==0) ? sm.stateTop=lastState : sm.stateTop--; sm.stateSub1=0; sm.action=FSM_ACTION_ENTRY;}

#define fsmSetStateSub1(sm, newState) {sm.stateSub1=newState; sm.action=FSM_ACTION_ENTRY;}

#define fsmIncStateSub1(sm, lastState) { (sm.stateSub1==lastState) ? sm.stateSub1=1 : sm.stateSub1++; sm.action=FSM_ACTION_ENTRY;}

#define fsmDecStateSub1(sm, lastState) { (sm.stateSub1==1) ? sm.stateSub1=lastState : sm.stateSub1--; sm.action=FSM_ACTION_ENTRY;}
#endif