HFSM2 开源项目使用教程

1. 项目的目录结构及介绍

HFSM2 是一个高性能的分层有限状态机（Hierarchical Finite State Machine, HFSM）框架，使用 C++11 编写，具有完全静态定义的结构，不使用动态内存分配。以下是项目的目录结构及其介绍：

HFSM2/
├── CMake/
│   └── modules/
├── assets/
├── development/
│   └── hfsm2/
├── examples/
├── external/
│   └── doctest/
├── include/
│   └── hfsm2/
├── projects/
├── test/
└── tools/
    ├── editorconfig
    ├── gitignore
    ├── CMakeLists.txt
    ├── CNAME
    ├── CODE_OF_CONDUCT.md
    ├── LICENSE
    ├── README.md
    ├── _config.yml
    ├── hfsm2.natvis
    ├── premake.cmd
    └── premake.lua

目录结构介绍

• CMake/: 包含 CMake 构建系统的模块文件。
• assets/: 存放项目相关的资源文件。
• development/hfsm2/: 开发相关的文件和工具。
• examples/: 包含项目的示例代码，展示了如何使用 HFSM2 框架。
• external/doctest/: 外部依赖库，包含 doctest 单元测试框架。
• include/hfsm2/: 包含 HFSM2 框架的头文件。
• projects/: 存放项目相关的配置文件和项目文件。
• test/: 包含项目的测试代码。
• tools/: 包含项目的工具文件，如编辑器配置、Git 配置、CMake 配置等。

2. 项目的启动文件介绍

HFSM2 是一个头文件库，因此没有传统的“启动文件”。要使用 HFSM2，只需将 include/hfsm2/ 目录中的头文件包含到你的项目中即可。以下是一个简单的示例，展示了如何包含和使用 HFSM2：

#include <hfsm2/machine.hpp>

// 定义状态机
using M = hfsm2::Machine;

// 定义状态
struct State1 : M::State {};
struct State2 : M::State {};

// 定义状态机结构
using FSM = M::PeerRoot<State1, State2>;

int main() {
    FSM fsm;
    fsm.changeTo<State2>();
    return 0;
}

3. 项目的配置文件介绍

HFSM2 是一个头文件库，因此没有传统的配置文件。项目的配置主要通过 CMake 和编译器宏来实现。以下是一些常见的配置方式：

CMake 配置

在项目的根目录下，有一个 CMakeLists.txt 文件，用于配置项目的构建系统。你可以通过修改这个文件来配置项目的构建选项。

编译器宏配置

HFSM2 提供了一些宏来配置框架的行为，例如：

• HFSM_ENABLE_STRUCTURE_REPORT: 启用状态机结构的报告功能。
• HFSM_ENABLE_LOGGING: 启用日志记录功能。

你可以在编译时通过定义这些宏来配置 HFSM2 的行为。例如：

g++ -DHFSM_ENABLE_STRUCTURE_REPORT main.cpp -o main

通过这种方式，你可以在编译时灵活地配置 HFSM2 框架的行为。

---

以上是 HFSM2 开源项目的使用教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望这些内容能帮助你更好地理解和使用 HFSM2 框架。