Adopt stateforward::sml as the public include surface#14
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR introduces stateforward::sml as the fork’s primary public include/namespace surface by adding include/stateforward/... wrapper headers while retaining the existing boost::sml implementation and updating installation metadata and shipped examples accordingly.
Changes:
- Added
include/stateforward/sml.hppand wrapper utility headers underinclude/stateforward/sml/utility/. - Updated installation/packaging metadata (CMake install + Conan metadata) and top-level docs to point to the
stateforwardentry point. - Migrated shipped examples from
<boost/sml.hpp>/boost::smlto<stateforward/sml.hpp>/stateforward::sml.
Reviewed changes
Copilot reviewed 35 out of 35 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| zephyr/README.md | Updates Zephyr module docs to include stateforward/sml.hpp. |
| zephyr/Kconfig | Updates Kconfig prompt/help text to refer to stateforward::sml. |
| README.md | Updates fork-facing README include paths and namespace alias to stateforward::sml, including utility header paths. |
| include/stateforward/sml.hpp | Adds the primary wrapper header mapping stateforward::sml to boost::sml. |
| include/stateforward/sml/utility/sm_pool.hpp | Adds wrapper include for sm_pool under the stateforward path. |
| include/stateforward/sml/utility/dispatch_table.hpp | Adds wrapper include for dispatch_table under the stateforward path. |
| include/stateforward/sml/utility/co_sm.hpp | Adds wrapper include for co_sm under the stateforward path. |
| include/boost/sml.hpp | Updates one static_assert message to reference stateforward::sml types. |
| example/visitor.cpp | Migrates example to stateforward include/namespace and updates internal qualified names. |
| example/transitions.cpp | Migrates example to stateforward include/namespace. |
| example/testing.cpp | Migrates example to stateforward include/namespace. |
| example/states.cpp | Migrates example to stateforward include/namespace. |
| example/sdl2.cpp | Migrates example to stateforward include/namespace and wrapper utility include. |
| example/plant_uml.cpp | Migrates example to stateforward include/namespace and updates qualified type-name calls. |
| example/orthogonal_regions.cpp | Migrates example to stateforward include/namespace. |
| example/nested.cpp | Migrates example to stateforward include/namespace. |
| example/logging.cpp | Migrates example to stateforward include/namespace. |
| example/in_place.cpp | Migrates example to stateforward namespace alias in deduction-guides branch. |
| example/history.cpp | Migrates example to stateforward include/namespace. |
| example/hello_world.cpp | Migrates example to stateforward include/namespace. |
| example/events.cpp | Migrates example to stateforward include/namespace. |
| example/eval.cpp | Migrates example to stateforward include/namespace. |
| example/euml_emulation.cpp | Migrates example to stateforward include/namespace. |
| example/error_handling.cpp | Migrates example to stateforward include/namespace. |
| example/dispatch_table.cpp | Migrates example to stateforward wrapper utility include and namespace. |
| example/dispatch_policy.cpp | Migrates example to stateforward include/namespace. |
| example/dependency_injection.cpp | Migrates example to stateforward include/namespace. |
| example/dependencies.cpp | Migrates example to stateforward include/namespace. |
| example/defer_and_process.cpp | Migrates example to stateforward include/namespace. |
| example/data.cpp | Migrates example to stateforward include/namespace and using namespace usage. |
| example/composite.cpp | Migrates example to stateforward include/namespace. |
| example/arduino.cpp | Migrates example to stateforward include/namespace and updates fully-qualified SML usages. |
| example/actions_guards.cpp | Migrates example to stateforward include/namespace. |
| conanfile.py | Updates Conan metadata (URL/description) for the stateforward fork branding. |
| CMakeLists.txt | Installs the new include/stateforward headers alongside include/boost. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
include/stateforward/...wrapper headers that exposestateforward::smlwhile keeping the existingboost::smlimplementation intactstateforwardentry point#include <stateforward/sml.hpp>andstateforward::smlVerification
cmake -S . -B build-stateforward -DSML_BUILD_EXAMPLES=ONcmake --build build-stateforward --target hello_world dispatch_table visitor actions_guards -- -j4