StateMachineCompiler for C 根据状态表生成【层次状态机】【C代码】

C State Machine Compiler by Ring Yee (RingYee@Gmail.com) 2008-09-10 Introduction: Generate C source code of Hierarchical state machine by state table scripts Reference: 1. Hierarchical State Machines - a Fundamentally Important Way of Design by Miro Samek, Ph.D. 2003 2. State-Oriented Programming by Miro Samek and Paul Montgomery 3. The Care and Feeding of the State Map Compiler by Robert Martin, 1993 Required environment: Python-2.5.2 How to use: python smc.py xxx.sm After generate: Two folders and four files are generated: folder: one is 'hsm', the other's name is same with %HSMName files: gen_hsm.c, gen_hsm.h; gen_hsm_eng.c, gen_hsm_eng.h gen_hsm_eng.c and gen_hsm_eng.h: The two files include all source files located in folder 'hsm' gen_hsm.c, gen_hsm.h: The two files include all source files located in folder which's name is same with %HSMName To avoid compiling error caused by header including, Make sure ONLY C source file includes the two header files: gen_hsm.h and gen_hsm_eng.h Now you can use the HSM with the following functions: step1: Create a FSM <%FSMName> * NEW(<%FSMName>) ("fsm name") To new an FSM which's name is 'fsm name' <%FSMName> *pFSM = NULL; pFSM = NEW(<%FSMName>) ("fsm name"); step2: Init this FSM MCALL(HSM, Init, (<%FSMName> *)pFsm) END_CALL To init the created FSM MCALL(HSM, Init, pFSM) END_CALL; step3: Handler the event MCALL(HSM, OnEvt, (<%FSMName> *)pFsm), (Event *)pEvt END_CALL; To precoss the event: pEvt MCALL(HSM, OnEvt, pFSM) ,pEvt END_CALL; step4: after finish running the fsm, destroy it void DEL(<%FSMName>) (<%FSMName> **ppFSM) To destroy an FSM DEL(<%FSMName>) (&pFSM); NOTE: The type definition of Event is included in gen_hsm_eng.h. You MUST create/destroy an event with the following: Event *pEvt = NULL; /* if the event has no event data, leaves pEvtData NULL and evtDataLen is 0 */ pEvt = NEW(Event) (evtId, pEvtData, evtDataLen); /* precoss the event.... */ DEL(Event) (&pEvt); In default, the macro of _SUPPORT_DBG is defined in gen_hsm_eng.h. If the event is not handled by each state, it will be delivered to topmost state and assertion works You can remove the macro in gen_hsm_eng.h to avoid assertion. But it is not recommanded Rules for writing SM file: The sign '#' means one line comments [Header:] KEYWORDS: %HSMName: name %Context: context %Header: header1, header2... %Version: version NOTE: Name for %HSMName and %Context MUST be in the format: [A-Za-z_][A-Za-z0-9_]* The name of %HSMName and %Context MUST NOT be the same If %HSMName, %Context and %Version are not defined, the default value will be used: _SMC_Default_Name, _SMC_Default_Ctxt and _SMC_Default_V0.01 You MUST typedef your FSM context as <%Context>. For example, if value of <%Context> is FsmContext, you must typedef the type in your header: typedef struct xxxxx { structure member define; }FsmContext; And this header MUST be one of the value of <%Header> %Header is to include the header files which declare the name of %Context, and the functions used in the SM file. (These functions MUST be implemented by yourself) If there is no headers needed to be included, this field can be not present or just leaves the vaule as blank If there are more than one header files to be included, they MUST be separated by sign ',' The value of %Version will be included as file comments in the generated source files All the definition of each value MUST be in one line, following is invalid: %Header: header1, header2 %Version:This is the version of the SM file It shall be written as: %Header: header1, header2 %Version:This is the version of the SM file [Body:] The body MUST begin with sign '%%' and end with '%%' also. Each sign MUST be in one line In the body, the SM table MUST be present, each state MUST be the format: State[InitSubstate]:SuperState >EntryFunction <ExitFunction { TriggledEvent NextState {action1, action2} TriggledEvent NextState {action1, action2} #other transitions } Name of state, triggled event and function MUST be in the format: [A-Za-z_][A-Za-z0-9_]* The <State> MUST be present as state name. The <InitSubstate> is optional if <State> has no init sub state. when the init sub state is present, it MUST be surrounded by sign '[' and ']' If <State> has parent state <SuperState>, the sign ':' MUST be used to separated them. The entry function and exit function are optional for the <State>. If they are present, the sign ' '(whitespace or tab) MUST be used to separated each one, and the entry function MUST be started with sign '>', exit function MUST be started with sign '<' Statement of "State[InitSubstate]:SuperState >EntryFunction <ExitFunction" MUST locate in one line. Then followed a line with sign '{' to represent beginning to transitions definition. The transition is as the following: +------+ TriggledEvt/ +---------+ |State |----------------------->|NextState| +------+ (action1, action2) +---------+ When <TriggledEvent> comes, the actions in {action1, action2} are executed at first, and then following state transition: transit to <NextState>. <TriggledEvent>, <NextState> and <{acitons}> MUST be separated with sign ' '(whitespace or tab). The actions MUST be surrounded wiht sign '{' and '}'. If no actions in this transition, just leaves it blank. Each transition MUST locate in one line The definition of state MUST be end with sign '}' in one line Your effort: After the %Context is defiend, you MUST implement the Init and DeInit function to init and deinit context of this FSM. The name rule for the two functions is: Init%Context and DeInit%Context. For example,if %Context is defined as 'FsmContext', the init and deinit functions MUST like: InitFsmContext and DeInitFsmContext If the Entry or Exit function of some states are present, you MUST implement these functions If the actions are present for some transitions, you MUST implement these functions NOTE: The parameter for all function is unfied with: %Context *pCtxt. And the return type for each function is 'void' Example: #--------------------Watch.sm %HSMName: Watch %Context: WatchCtxt #init func is: void InitWatchCtxt(WatchCtxt *) #deinit func is: void DeInitWatchCtxt(WatchCtxt *) %Header: watch_hsm.h %Version: V0.01 2008/09/02 # State machine: # +----------------------------------------------------------------------+ # | Top | # | INIT_ST | # | | | # | V | #