sm_api.h

Go to the documentation of this file.

/*
    MIT License
 
    Copyright (c) 2025 Robin A. Onsay
 
    Permission is hereby granted, free of charge, to any person obtaining
    a copy of this software and associated documentation files
    (the "Software"), to deal in the Software without restriction,
    including without limitation the rights to use, copy, modify, merge,
    publish, distribute, sublicense, and/or sell copies of the Software,
    and to permit persons to whom the Software is furnished to do so,
    subject to the following conditions:
 
    The above copyright notice and this permission notice shall be
    included in all copies or substantial portions of the Software.
*/
 
#ifndef JUNO_SM_API_H
#define JUNO_SM_API_H
#include "juno/macros.h"
#include "juno/status.h"
#include "juno/module.h"
#include "juno/types.h"
#include <stdbool.h>
#include <stddef.h>
#ifdef __cplusplus
extern "C"
{
#endif
 
typedef struct JUNO_SM_ROOT_TAG JUNO_SM_ROOT_T;
typedef struct JUNO_SM_STATE_API_TAG JUNO_SM_STATE_API_T;
 
typedef struct JUNO_SM_STATE_ROOT_TAG JUNO_SM_STATE_ROOT_T;
 
JUNO_MODULE_RESULT(JUNO_SM_RESULT_STATE_ROOT_T, JUNO_SM_STATE_ROOT_T *);
JUNO_MODULE_RESULT(JUNO_SM_RESULT_STATE_T, JUNO_SM_STATE_ROOT_T *);
JUNO_MODULE_OPTION(JUNO_SM_OPTION_STATE_ROOT_T, JUNO_SM_STATE_ROOT_T *);
JUNO_MODULE_OPTION(JUNO_SM_OPTION_STATE_T, JUNO_SM_STATE_ROOT_T *);
JUNO_MODULE_RESULT(JUNO_SM_RESULT_OPTION_STATE_ROOT_T, JUNO_SM_OPTION_STATE_ROOT_T);
JUNO_MODULE_RESULT(JUNO_SM_RESULT_OPTION_STATE_T, JUNO_SM_OPTION_STATE_T);
 
// @{"req": ["REQ-SM-002"]}
struct JUNO_SM_STATE_ROOT_TAG JUNO_MODULE_ROOT(JUNO_SM_STATE_API_T,
    JUNO_SM_ROOT_T *ptSm;
    JUNO_SM_OPTION_STATE_T tOptionNextState;
);
 
// @{"req": ["REQ-SM-003"]}
struct JUNO_SM_STATE_API_TAG
{
    JUNO_STATUS_T (*StateAction)(JUNO_SM_STATE_ROOT_T *ptJunoSm);
    JUNO_RESULT_BOOL_T (*ShouldExit)(JUNO_SM_STATE_ROOT_T *ptJunoSm);
    JUNO_STATUS_T (*ResetState)(JUNO_SM_STATE_ROOT_T *ptJunoSm);
};
 
// @{"req": ["REQ-SM-001"]}
struct JUNO_SM_ROOT_TAG JUNO_MODULE_ROOT(void,
    JUNO_SM_STATE_ROOT_T *ptCurrentState;
);
 
// @{"req": ["REQ-SM-009"]}
static inline JUNO_STATUS_T JunoSm_Verify(JUNO_SM_ROOT_T *ptSmRoot)
{
    JUNO_ASSERT_EXISTS(ptSmRoot);
    JUNO_ASSERT_EXISTS(ptSmRoot->ptCurrentState);
    return JUNO_STATUS_SUCCESS;
}
 
// @{"req": ["REQ-SM-010", "REQ-SM-011"]}
static inline JUNO_STATUS_T JunoSm_StateVerify(JUNO_SM_STATE_ROOT_T *ptSmState)
{
    JUNO_ASSERT_EXISTS(ptSmState);
    JUNO_ASSERT_EXISTS(ptSmState->ptApi && ptSmState->ptSm);
    if(ptSmState->tOptionNextState.bIsSome)
    {
        JUNO_ASSERT_EXISTS(ptSmState->tOptionNextState.tSome);
    }
    return JUNO_STATUS_SUCCESS;
}
 
// @{"req": ["REQ-SM-005"]}
static inline JUNO_STATUS_T JunoSm_StateInit(JUNO_SM_ROOT_T *ptSm, JUNO_SM_STATE_ROOT_T *ptStateRoot, JUNO_SM_STATE_ROOT_T *ptNextState, const JUNO_SM_STATE_API_T *ptStateApi, JUNO_FAILURE_HANDLER_T pfcnFailureHandler, JUNO_USER_DATA_T *pvFailureUserData)
{
    JUNO_ASSERT_EXISTS(ptStateRoot && ptStateApi && ptSm);
    ptStateRoot->ptSm = (JUNO_SM_ROOT_T *) ptSm;
    ptStateRoot->_pfcnFailureHandler = pfcnFailureHandler;
    ptStateRoot->_pvFailureUserData = pvFailureUserData;
    ptStateRoot->ptApi = ptStateApi;
    if(ptNextState)
    {
        ptStateRoot->tOptionNextState.bIsSome = true;
        ptStateRoot->tOptionNextState.tSome = (JUNO_SM_STATE_ROOT_T *) ptNextState;
    }
    else
    {
        ptStateRoot->tOptionNextState.bIsSome = false;
        ptStateRoot->tOptionNextState.tSome = NULL;
    }
    return JunoSm_StateVerify(ptStateRoot);
}
 
// @{"req": ["REQ-SM-004"]}
static inline JUNO_STATUS_T JunoSm_Init(JUNO_SM_ROOT_T *ptSmRoot, JUNO_SM_STATE_ROOT_T *ptStartState, JUNO_FAILURE_HANDLER_T pfcnFailureHandler, JUNO_USER_DATA_T *pvFailureUserData)
{
    JUNO_ASSERT_EXISTS(ptSmRoot);
    ptSmRoot->ptCurrentState = (JUNO_SM_STATE_ROOT_T *) ptStartState;
    ptSmRoot->_pfcnFailureHandler = pfcnFailureHandler;
    ptSmRoot->_pvFailureUserData = pvFailureUserData;
    JUNO_STATUS_T tStatus = JunoSm_Verify(ptSmRoot);
    JUNO_ASSERT_SUCCESS(tStatus, return tStatus);
    return tStatus;
}
 
// @{"req": ["REQ-SM-006"]}
static inline JUNO_SM_RESULT_STATE_T JunoSm_GetCurrentState(JUNO_SM_ROOT_T *ptSmRoot)
{
    JUNO_SM_RESULT_STATE_T tResult = {JUNO_STATUS_ERR, NULL};
    tResult.tStatus = JunoSm_Verify(ptSmRoot);
    JUNO_ASSERT_SUCCESS(tResult.tStatus, return tResult);
    tResult.tStatus = JUNO_STATUS_SUCCESS;
    tResult.tOk = ptSmRoot->ptCurrentState;
    return tResult;
}
 
// @{"req": ["REQ-SM-007", "REQ-SM-008"]}
static inline JUNO_SM_RESULT_OPTION_STATE_T JunoSm_TransitionState(JUNO_SM_ROOT_T *ptSmRoot)
{
    JUNO_SM_RESULT_OPTION_STATE_T tResult = JUNO_ERR_RESULT(JUNO_STATUS_ERR,
        JUNO_NONE_OPTION(NULL)
    ); 
    tResult.tStatus = JunoSm_Verify(ptSmRoot);
    JUNO_ASSERT_SUCCESS(tResult.tStatus, return tResult);
    tResult.tStatus = JUNO_STATUS_SUCCESS;
    JUNO_SM_STATE_ROOT_T *ptCurrentStateRoot = (JUNO_SM_STATE_ROOT_T*) ptSmRoot->ptCurrentState;
    if(ptCurrentStateRoot->tOptionNextState.bIsSome)
    {
        ptSmRoot->ptCurrentState = ptCurrentStateRoot->tOptionNextState.tSome;
        tResult.tOk.bIsSome = true;
        tResult.tOk.tSome = ptSmRoot->ptCurrentState;
    }
    else
    {
        tResult.tOk.bIsSome = false;
        tResult.tOk.tSome = NULL;
    }
    return tResult;
}
 
#ifdef __cplusplus
}
#endif
#endif // JUNO_SM_API_H