狀態機編程實例-狀態表法
上篇文章，使用嵌套switch-case法的狀態機編程，實現了一個炸彈拆除小游戲。
本篇，繼續介紹狀態機編程的第二種方法：狀態表法，來實現炸彈拆除小游戲的狀態機編程。
1 狀態表法
狀態表法，顧名思義，就是通過一個狀態表，來實現狀態機中的狀態轉換，下面就先介紹下狀態表的基礎知識。
1.1 狀態表
狀態表 ，最常用的是使用一個2維狀態表：
- 水平方向是各個事件
- 豎直方向是各個狀態
- 單元的內容是通過（執行動作，下一狀態）來表示各種轉換關系
結合上一篇設計炸彈拆除小游戲的狀態圖（2個狀態和4個事件）：
可以設計出對應的狀態表，如下圖：
- 水平方向的4種事件：UP、DOWN和ARM按鍵事件，TICK事件
- 豎直方向的2種狀態：設置狀態和倒計時狀態
- 單元的內容表示執行指定動作后，下一狀態是什么。比如設置狀態時按下UP鍵，執行setting_UP函數中的動作后，下一狀態還是留在設置狀態
注意：
- （*）：僅當（me->code == me->defuse），即密碼輸入正確時，才進行狀態轉換至“設置狀態”
- （ ）：僅當（me->fine_time == 0）和（me->timeout != 0），即每過一秒且倒計時未減到0時，才進行狀態轉換至“倒計時狀態”**
1.2 事件處理器
由于狀態表法可以使用一個非常有規律的數據結構（狀態表）來表現一個狀態機，因此編程時可以編寫一個通用的“事件處理器”來實現狀態機功能。
如下圖，通用的狀態表事件處理器，包含兩個主要結構：
- 一個外部轉換的StateTable結構
- 一個帶有事件參數和沒有事件參數的Event結構
此外，StateTable結構有兩個相關的函數：
- init()函數用于觸發狀態機的初始轉換
- dispatch()函數用于派送一個事件給狀態機處理
需體會的是，StateTable結構是一個抽象的結構，按照UML類圖的畫法，這是一個抽象類（使用《abstract》或斜體類名表示），需要通過派生出一個實例類，如圖中的Bomb2，來實現具體的業務功能。
在狀態機的應用程序中，狀態表僅包含執行轉換函數的指針，即函數指針，而不是（執行動作，下一狀態）的形式，使用這種方式，實際就是把狀態改變的邏輯，放到了轉換函數中，這樣做，使得編程更加靈活，因為狀態函數能方便地判斷某些監護條件并隨之改變。
2 狀態表法的實現
上面介紹了狀態表法的基礎知識，下面就來通過代碼來介紹狀態表法的具體實現。
2.1 通用狀態表事件處理器
上面說到，狀態表法可以使用一個非常有規律的狀態表數據結構來表現一個狀態機，因而在程序設計時，可以編寫一個通用的狀態表事件處理器。
2.1.1 接口定義
通用的狀態表事件處理器，先來通過接口定義，看下它的功能。
注意上面提到的它包含兩個主要結構：
- 一個外部轉換的StateTable結構
- 一個帶有事件參數和沒有事件參數的Event結構
以及StateTable結構的兩個相關的函數：
- init()函數：用于觸發狀態機的初始轉換
- dispatch()函數：用于派送一個事件給狀態機處理
// 用于進行狀態轉換的宏
#define TRAN(target) (((StateTable *)me)- >state = (uint8_t)(target))
?
typedef struct EventTag
{
uint16_t sig; // 事件的信號
} Event;
?
struct StateTableTag; //提前聲明此變量
?
// 函數指針
typedef void (*Tran)(struct StateTableTag *me, Event const *e);
?
// 狀態表數據結構
typedef struct StateTableTag
{
uint8_t state; //當前狀態
Tran const *state_table; //狀態表
uint8_t n_states; //狀態的個數
uint8_t n_signals; //事件(信號)的個數
Tran initial; //初始轉換
} StateTable;
?
void StateTable_ctor(StateTable *me, Tran const *table, uint8_t n_states, uint8_t n_signals, Tran initial);
void StateTable_init(StateTable *me);
void StateTable_dispatch(StateTable *me, Event const *e);
void StateTable_empty(StateTable *me, Event const *e);
StateTable_ctor是狀態表的“構造函數”，僅指向一個基本的初始化動作，不會觸發初始轉換。
StateTable_empty是一個默認的空動作，用于狀態表初始化時，某些需要空單元的地方使用。
另外，這里還要體會函數指針的用法。什么是函數指針，下面再來復習一下。
2.1.2 體會函數指針的用法
函數指針，本質是一個指針，其指向的一個函數，其類型定義為：
返回值類型 (* 函數名) ([形參列表]);
注意和指針函數的區別：
何為指針函數？
*指針函數，本質是一個函數，例如 int pfun(int, int); 其返回值是指針類型，即返回一個指針（或稱地址），這個指針指向的數據是什么類型都可以。
一個記憶小技巧：指針函數，可以類比int函數，它們都是函數，只是返回值不一樣，一個是返回指針，一個返回int。
首先來看函數指針的定義，以及基礎用法：
//定義一個函數指針pFUN，它指向一個返回類型為void，有一個參數類型為int的函數
void (*pFun)(int);
?
//定義一個返回類型為void，參數為int的函數。從指針層面上理解該函數，其函數名實際上是一個指針，該指針指向函數在內存中的首地址
void glFun(int a)
{
printf("%d
", a);
}
?
int main()
{
pFun = glFun; //將函數glFun的地址賦值給變量pFun
(*pFun)(2);//“*pFun”是取pFun所指向地址的內容，即取出了函數glFun()的內容，然后給定參數為2
return 0;
}
實際使用時，常常通過typedef的方式讓函數指針更直觀方便的進行使用：
//定義新的類型PTRFUN, 此類型的實際含義為函數指針，指向的函數的返回值是void，參數是int
typedef void (*PTRFUN)(int);
?
//定義一個返回類型為void，參數為int的函數
void glFun(int a)
{
printf("%d
", a);
}
?
int main()
{
PTRFUN pFun; //使用定義的（函數指針）類型，實例化一個函數指針
pFun = glFun; //把定義的glFun函數，以函數名（本質即指針）的形式為其賦值
(*pFun)(2); //執行該函數指針指向的內容，即指向指向的函數，并指定參數2
return 0;
}
關于函數指針的實際應用，也可參考我之前的這篇文章： STM32簡易多級菜單(數組查表法)
2.1.3 具體實現
看完了通用的狀態表事件處理器的接口定義，下面再來看下具體實現。
//狀態表的構造
void StateTable_ctor(StateTable *me,
Tran const *table, uint8_t n_states, uint8_t n_signals,
Tran initial)
{
//第一個參數me為StateTable結構，由具體業務的派生狀態表的tateTable結構傳入
me- >state_table = table; //狀態表, 由具體業務的二維狀態表傳入
me- >n_states = n_states; //二維狀態表的狀態數量
me- >n_signals = n_signals; //二維狀態表的信號(事件)數量
me- >initial = initial; //狀態表的初始準換函數
}
?
//狀態表的初始化
void StateTable_init(StateTable *me)
{
me- >state = me- >n_states;
(*me- >initial)(me, (Event *)0); //初始轉換
?
assert(me- >state < me- >n_states); //確保事件范圍的合理
}
?
//狀態表的調度(派送一個事件給狀態機處理)
void StateTable_dispatch(StateTable *me, Event const *e)
{
Tran t;
?
assert(e- >sig < me- >n_signals); //確保信號范圍的合理
?
//通過當前狀態與當前的信號，以及信號的總數，計算得到狀態表中要執行的轉換函數在狀態表(二維的函數指針數組)中的位置
t = me- >state_table[me- >state * me- >n_signals + e- >sig];
(*t)(me, e); //然后執行轉換函數
?
assert(me- >state < me- >n_states); //確保狀態范圍的合理
}
?
//狀態表的空元素
void StateTable_empty(StateTable *me, Event const *e)
{
(void)me; //用于消除參數未使用的警告
(void)e;
}
這里要體會一下狀態表的調度，即派送一個事件給狀態機處理的代碼邏輯，StateTable_dispatch的兩個參數，一個是StateTable結構的二維表，一個是Event結構的信號(事件)，注意這個二維狀態表，存儲的函數指針(各種轉換函數)，所以是一個二維的函數指針數組，根據信號，如何知道要執行二維數組中的哪個函數呢？還要借助當前狀態機所處的狀態，即可通過簡單的數學運算得出，示意如下圖：
2.2 應用邏輯(具體業務代碼)
看完了通用的狀態表事件處理器，就可以在此基礎上，編寫具體的狀態機業務代碼，實現上一篇介紹的炸彈拆除小游戲。
2.2.1 接口定義
還是先看下炸彈拆除小游戲這個具體業務邏輯用到的數據結構與接口定義，主要包括：
- 炸彈狀態機的狀態與信號(事件)
- 從狀態表事件處理器的Event結構派生的帶有事件參數的TickEvt結構
- 從狀態表事件處理器的StateTable結構派生的具體的炸彈狀態機數據結構
- 狀態表中用到的所有的轉換函數
// 炸彈狀態機的所有狀態
enum BombStates
{
SETTING_STATE, // 設置狀態
TIMING_STATE, // 倒計時狀態
STATE_MAX
};
?
// 炸彈狀態機的所有信號(事件)
enum BombSignals
{
UP_SIG, // UP鍵信號
DOWN_SIG, // DOWN鍵信號
ARM_SIG, // ARM鍵信號
TICK_SIG, // Tick節拍信號
SIG_MAX
};
?
typedef struct TickEvtTag
{
Event super; // 派生自Event結構
uint8_t fine_time; // 精細的1/10秒計數器
} TickEvt;
?
// 炸彈狀態機數據結構
typedef struct Bomb2Tag
{
StateTable super; // 派生自StateTable結構
uint8_t timeout; // 爆炸前的秒數
uint8_t code; // 當前輸入的解除炸彈的密碼
uint8_t defuse; // 解除炸彈的拆除密碼
uint8_t errcnt; // 當前拆除失敗的次數
} Bomb2;
?
//炸彈構造
void Bomb2_ctor(Bomb2 *me, uint8_t defuse);
//狀態表中需要用到的轉換函數(函數指針)
void Bomb2_initial(Bomb2 *me, Event const *e); //初始轉換
void Bomb2_setting_UP(Bomb2 *me, Event const *e); //轉換函數, 設置狀態時, 處理UP事件
void Bomb2_setting_DOWN(Bomb2 *me, Event const *e); //轉換函數, 設置狀態時, 處理DOWN事件
void Bomb2_setting_ARM(Bomb2 *me, Event const *e); //轉換函數, 設置狀態時, 處理ARM事件
void Bomb2_timing_UP(Bomb2 *me, Event const *e); //轉換函數, 倒計時狀態時, 處理UP事件
void Bomb2_timing_DOWN(Bomb2 *me, Event const *e); //轉換函數, 倒計時狀態時, 處理DOWN事件
void Bomb2_timing_ARM(Bomb2 *me, Event const *e); //轉換函數, 倒計時狀態時, 處理ARM事件
void Bomb2_timing_TICK(Bomb2 *me, Event const *e); //轉換函數, 倒計時狀態時, 處理Tick事件