module.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_MODULE_H
#define JUNO_MODULE_H
 
#include "juno/status.h"
#include <stdint.h>
#include <stdbool.h>
// @{"req": ["REQ-SYS-002", "REQ-SYS-006", "REQ-SYS-009"]}
 
 
#define JUNO_MODULE_DECLARE(NAME_T)   typedef union NAME_T NAME_T
#define JUNO_MODULE_ROOT_DECLARE(NAME_T)   typedef struct NAME_T NAME_T
#define JUNO_MODULE_DERIVE_DECLARE(NAME_T)   JUNO_MODULE_ROOT_DECLARE(NAME_T)
 
#define JUNO_FAILURE_HANDLER    _pfcnFailureHandler
#define JUNO_FAILURE_USER_DATA    _pvFailureUserData
#define JUNO_MODULE_EMPTY
 
#define JUNO_MODULE_ARG(...)    __VA_ARGS__
 
#define JUNO_MODULE_SUPER   tRoot
 
// @{"req": ["REQ-MODULE-004"]}
#define JUNO_MODULE(API_T, ROOT_T, ...) \
{ \
    ROOT_T JUNO_MODULE_SUPER; \
    __VA_ARGS__ \
}
 
// @{"req": ["REQ-MODULE-001", "REQ-MODULE-002"]}
#define JUNO_MODULE_ROOT(API_T, ...) \
{ \
    const API_T *ptApi; \
    JUNO_FAILURE_HANDLER_T JUNO_FAILURE_HANDLER; \
    JUNO_USER_DATA_T *JUNO_FAILURE_USER_DATA; \
    __VA_ARGS__ \
}
 
#define JUNO_TRAIT_ROOT(API_T, ...) \
{ \
    const API_T *ptApi; \
    __VA_ARGS__ \
}
 
// @{"req": ["REQ-MODULE-003"]}
#define JUNO_MODULE_DERIVE(ROOT_T, ...) \
{ \
    ROOT_T JUNO_MODULE_SUPER; \
    __VA_ARGS__ \
}
 
#define JUNO_TRAIT_DERIVE(ROOT_T, ...) JUNO_MODULE_DERIVE(ROOT_T, __VA_ARGS__)
 
#define JUNO_MODULE_GET_API(ptModule, ROOT_T) ((const ROOT_T *)ptModule)->ptApi
 
 
// @{"req": ["REQ-MODULE-005"]}
#define JUNO_MODULE_RESULT(NAME_T, OK_T) \
typedef struct NAME_T \
{ \
    JUNO_STATUS_T tStatus; \
    OK_T tOk; \
} NAME_T
 
#define JUNO_OK(result) result.tOk
#define JUNO_ASSERT_OK(result, ...) JUNO_ASSERT_SUCCESS(result.tStatus, __VA_ARGS__)
#define JUNO_OK_RESULT(value) {JUNO_STATUS_SUCCESS, value}
#define JUNO_ERR_RESULT(err, value) {err, value}
// @{"req": ["REQ-MODULE-006"]}
#define JUNO_MODULE_OPTION(NAME_T, SOME_T) \
typedef struct NAME_T \
{ \
    bool bIsSome; \
    SOME_T tSome; \
} NAME_T
 
#define JUNO_SOME(result) result.tSome
#define JUNO_ASSERT_SOME(result, ...) if(!result.bIsSome){ \
    __VA_ARGS__  \
}
#define JUNO_SOME_OPTION(value) {true, value}
#define JUNO_NONE_OPTION(default_value) {false, default_value}
 
#endif // JUNO_MODULE_H