Skip to content

Nesting depth tracking #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
gjosipovic wants to merge 2 commits into
base: master
Choose a base branch
from
+20 −16
Open

Nesting depth tracking #29

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
eee7572
Initial commit
gjosipovic Mar 14, 2026
821748b
Removes runtime state nesting depth tracking
gjosipovic Mar 20, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions include/qp.hpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -314,20 +314,24 @@ class QHsm : public QP::QAsm {
QStateHandler childState(QStateHandler const parentHndl) noexcept;

private:
// maximum depth of state nesting in a QHsm (including the top level)
// Maximum nesting depth (including the top level) that has been fully
// tested (including MC/DC coverage)
// The QHsm implementation is verified only up to this level
// Application designers must ensure state nesting does not exceed this
// value.
// must be >= 3
static constexpr std::size_t MAX_NEST_DEPTH_ {6U};
static constexpr std::size_t MAX_TESTED_NEST_DEPTH_ {6U};

std::size_t tran_simple_(
std::array<QStateHandler, MAX_NEST_DEPTH_> &path,
std::array<QStateHandler, MAX_TESTED_NEST_DEPTH_> &path,
std::uint_fast8_t const qsId);

std::size_t tran_complex_(
std::array<QStateHandler, MAX_NEST_DEPTH_> &path,
std::array<QStateHandler, MAX_TESTED_NEST_DEPTH_> &path,
std::uint_fast8_t const qsId);

void enter_target_(
std::array<QStateHandler, MAX_NEST_DEPTH_> &path,
std::array<QStateHandler, MAX_TESTED_NEST_DEPTH_> &path,
std::size_t const depth,
std::uint_fast8_t const qsId);

Expand Down
22 changes: 11 additions & 11 deletions src/qf/qep_hsm.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -190,12 +190,12 @@ void QHsm::init(
QS_TRAN_SEG_(QS_QEP_STATE_INIT, s, m_temp.fun); // output QS record

// drill down into the state hierarchy with initial transitions...
std::array <QStateHandler, MAX_NEST_DEPTH_> path; // entry path array
std::array <QStateHandler, MAX_TESTED_NEST_DEPTH_> path; // entry path array

std::size_t ip = 0U; // path index & fixed loop bound
do {
// the entry path index must not overflow the allocated array
Q_INVARIANT_LOCAL(260, ip < MAX_NEST_DEPTH_);
Q_INVARIANT_LOCAL(260, ip < MAX_TESTED_NEST_DEPTH_);

// the initial tran. must set target in temp
Q_ASSERT_LOCAL(270, m_temp.fun != nullptr);
Expand Down Expand Up @@ -248,10 +248,10 @@ void QHsm::dispatch(
QS_TRAN0_(QS_QEP_DISPATCH, s); // output QS record

// process the event hierarchically...
std::array <QStateHandler, MAX_NEST_DEPTH_> path; // entry path array
std::array <QStateHandler, MAX_TESTED_NEST_DEPTH_> path; // entry path array
m_temp.fun = s;
QState r; // state handler return value
std::size_t ip = MAX_NEST_DEPTH_; // path index & fixed loop bound
std::size_t ip = MAX_TESTED_NEST_DEPTH_; // path index & fixed loop bound
do {
// the entry path index must stay in range of the path[] array
Q_INVARIANT_LOCAL(340, ip != 0U);
Expand Down Expand Up @@ -293,7 +293,7 @@ void QHsm::dispatch(
path[0U] = m_temp.fun; // save tran. target in path[0]

// exit current state to tran. source (path[0] not used)...
for (std::size_t iq = MAX_NEST_DEPTH_ - 1U; iq > ip; --iq) {
for (std::size_t iq = MAX_TESTED_NEST_DEPTH_ - 1U; iq > ip; --iq) {
// exit from 'path[iq]'
if ((*path[iq])(this, &l_resEvt_[Q_EXIT_SIG]) == Q_RET_HANDLED) {
QS_STATE_ACT_(QS_QEP_STATE_EXIT, path[iq]); //output QS record
Expand Down Expand Up @@ -326,7 +326,7 @@ void QHsm::dispatch(
//............................................................................
//! @private @memberof QHsm
std::size_t QHsm::tran_simple_(
std::array<QStateHandler, MAX_NEST_DEPTH_> &path,
std::array<QStateHandler, MAX_TESTED_NEST_DEPTH_> &path,
std::uint_fast8_t const qsId)
{
#ifndef Q_SPY
Expand Down Expand Up @@ -393,7 +393,7 @@ std::size_t QHsm::tran_simple_(
//............................................................................
//! @private @memberof QHsm
std::size_t QHsm::tran_complex_(
std::array<QStateHandler, MAX_NEST_DEPTH_> &path,
std::array<QStateHandler, MAX_TESTED_NEST_DEPTH_> &path,
std::uint_fast8_t const qsId)
{
#ifndef Q_SPY
Expand All @@ -411,7 +411,7 @@ std::size_t QHsm::tran_complex_(
std::size_t iq = 0U; // assume that LCA is NOT found
do {
// the entry path index must stay in range of the path[] array
Q_INVARIANT_LOCAL(540, ip < MAX_NEST_DEPTH_);
Q_INVARIANT_LOCAL(540, ip < MAX_TESTED_NEST_DEPTH_);

path[ip] = m_temp.fun; // store temp in the entry path array
++ip;
Expand Down Expand Up @@ -482,7 +482,7 @@ std::size_t QHsm::tran_complex_(
//............................................................................
//! @private @memberof QHsm
void QHsm::enter_target_(
std::array<QStateHandler, MAX_NEST_DEPTH_> &path,
std::array<QStateHandler, MAX_TESTED_NEST_DEPTH_> &path,
std::size_t const depth,
std::uint_fast8_t const qsId)
{
Expand All @@ -493,7 +493,7 @@ void QHsm::enter_target_(
QS_CRIT_STAT
std::size_t ip = depth;

Q_REQUIRE_LOCAL(600, ip <= MAX_NEST_DEPTH_);
Q_REQUIRE_LOCAL(600, ip <= MAX_TESTED_NEST_DEPTH_);

// execute entry actions from LCA to tran target...
while (ip > 0U) {
Expand All @@ -518,7 +518,7 @@ void QHsm::enter_target_(
ip = 0U; // entry path index and fixed loop bound
do {
// the entry path index must stay in range of the path[] array
Q_INVARIANT_LOCAL(660, ip < MAX_NEST_DEPTH_);
Q_INVARIANT_LOCAL(660, ip < MAX_TESTED_NEST_DEPTH_);

path[ip] = m_temp.fun; // store the entry path
++ip;
Expand Down