CXXStateTree

KO | EN

gitlite — search

#hacktoberfest #react #llm #go #deep-learning #linux #nodejs #macos #awesome #kubernetes #pytorch #ios #openai #open-source

(★ 70)

A C++ Header-Only Hierarchical State Tree Library

파일 탐색기

최종 버전 다운로드 (.zip)

- - bug_report.md
  - feature_request.md
- - coverage.yml
  - test.yml
- pull_request_template.md
- settings.json
- logo.png
- social_preview.png
- basic.cpp
- context_example.cpp
- export_dot.cpp
- export_dot_context.cpp
- export_dot_nested.cpp
- nested.cpp
- - ContextUtil.hpp
  - IGuard.h
  - State.h
  - StateTree.h
  - Transition.h
- - State.cpp
  - StateTree.cpp
- state_tree_singleheader_test.cpp
- state_tree_test.cpp
.gitignore
CMakeLists.txt
CODE_OF_CONDUCT.md
codecov.yaml
config_CXXStateTree.json
config_CXXStateTree.prologue
CONTRIBUTING.md
LICENSE
README.md
SECURITY.md

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

<h1 align="center">CXXStateTree</h1>
<p align="center"><i>Modern Hierarchical State Machine for C++20</i></p>

## 🚀 Features

* 🔧 Fluent builder API with lambda-based DSL
* ⚡ Fast runtime performance with zero heap allocation
* 🛡️ Optional guards and actions for transitions
* 🔄 Event-based state transitions
* 🧪 Google Test integration
* 📈 Code coverage with Codecov
* 🌳 Designed for extensibility: nested states, DOT export coming soon
* 🔧 Deployed as Shared Library and as Single Header-Only library

---

## 🛠️ Quick Example

```cpp
#include <iostream>
#include "CXXStateTree/StateTree.hpp"

using namespace CXXStateTree;

int main() {
    auto machine = StateTree::Builder()
        .initial("Idle")
        .state("Idle", [](State& s) {
            s.on("Start", "Running", nullptr, []() {
                std::cout << "Idle -> Running" << std::endl;
            });
        })
        .state("Running", [](State& s) {
            s.on("Stop", "Idle", nullptr, []() {
                std::cout << "Running -> Idle" << std::endl;
            });
        })
        .build();

machine.send("Start");
    machine.send("Stop");
}
```

---

## 🛠️ Building Shared Library

```bash
cmake -S . -B build 
cmake --build build
```

After these command the Shared Library can be found in `build` directory

Please Note: in future release cmake will have the ability to install the library automatically, for now it is necessary to do it manually

---

## 🛠️ Building Single Header-Only Library

```bash
cmake -S . -B build -DENABLE_SINGLE_HEADER=ON
cmake --build build
```

After these command the Single Header-Only Library can be found in `single_include` directory with the name CXXStateTree.hpp

Please Note: in future release cmake will have the ability to install the library automatically, for now it is necessary to do it manually

---

## 🧪 Running Tests

```bash
cmake -S . -B build -DENABLE_TEST=ON -DENABLE_COVERAGE=ON
cmake --build build
cd build && ctest
```

---

## 📦 Dependencies

* C++20 compiler (GCC >= 10, Clang >= 11, MSVC >= 2019)
* [GoogleTest](https://github.com/google/googletest) (auto-downloaded via CMake)

---

## 📈 Code Coverage

[![codecov](https://codecov.io/gh/ZigRazor/CXXStateTree/graph/badge.svg?token=A1RP2ZDGI6)](https://codecov.io/gh/ZigRazor/CXXStateTree)

---

## 📂 Directory Structure

```
CXXStateTree/
├── include/CXXStateTree/     # Public header-only API
├── examples/                 # Usage examples
├── tests/                    # Google Test suite
├── CMakeLists.txt            # Project build
└── .github/workflows/ci.yml  # GitHub Actions CI
```

---

## 📋 License

MPL2.0 License — see [LICENSE](LICENSE) for details.

---

## 🌟 Coming Soon

* Nested (hierarchical) state support
* DOT/Graphviz state diagram export
* Transitions with context/parameters

| Completed | Milestone   | Features                                                           |
| :-: | :---------   | ------------------------------------------------------------------ |
| :heavy_check_mark: | v0.1.0      | Basic state machine with `send()`, transitions, and state tracking |
| :heavy_check_mark: | v0.2.0      | Guards and actions                                                 |
| :heavy_check_mark: | v0.3.0      | Nested (hierarchical) states                                       |
| :heavy_check_mark: | v0.4.0      | Graphviz export                                                    |
| :memo: | v0.5.0      | Coroutine/async support (optional)                                 |
| :memo: | v1.0.0      | Full unit test coverage, benchmarks, and docs                      |

---

## 👋 Contributions Welcome

Issues, feature suggestions, and PRs are welcome!

CXXStateTree

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

CXXStateTree

파일 탐색기

오늘의 추천 프로젝트

Was this content helpful?

Recent Feedback

Download README