component.h

Go to the documentation of this file.

// === component.h =====================================================================================================
//                                               Sen Infrastructure
//                   Released under the Apache License v2.0 (SPDX-License-Identifier Apache-2.0).
//                                    See the LICENSE.txt file for more information.
//                   © Airbus SAS, Airbus Helicopters, and Airbus Defence and Space SAU/GmbH/SAS.
// =====================================================================================================================
 
#ifndef SEN_KERNEL_COMPONENT_H
#define SEN_KERNEL_COMPONENT_H
 
// sen
#include "sen/core/base/compiler_macros.h"
#include "sen/core/base/result.h"
#include "sen/core/obj/object_list.h"
#include "sen/core/obj/object_ref.h"
 
// kernel
#include "sen/kernel/component_api.h"
#include "sen/kernel/kernel.h"
 
namespace sen::kernel
{

[[nodiscard]] inline PassResult done() { return Ok(OpState {OpFinished {}}); }

class Component
{
  SEN_NOCOPY_NOMOVE(Component)
 
public:  // special members
  Component() noexcept = default;
  virtual ~Component() = default;
 
public:
  // --8<-- [start:hooks]
  virtual FuncResult preload(PreloadApi&& /* api */) { return Ok(); }

  virtual FuncResult load(LoadApi&& /* api */) { return Ok(); }

  virtual PassResult init(InitApi&& /* api */) { return done(); }

  virtual FuncResult run(RunApi& /* api */) { return Ok(); }

  virtual FuncResult unload(UnloadApi&& /* api */) { return Ok(); }

  virtual void postUnloadCleanup() {}

  [[nodiscard]] virtual bool isRealTimeOnly() const noexcept { return false; }
  // --8<-- [end:hooks]
 
protected:  // helpers
  [[nodiscard]] static PassResult delay(Duration time) noexcept { return Ok(OpState {OpNotFinished {time}}); }

  [[nodiscard]] static PassResult done() noexcept { return kernel::done(); }
};
 
}  // namespace sen::kernel
 
//----------------------------------------------------------------------------------------------------------------------
// Inline implementation
//----------------------------------------------------------------------------------------------------------------------
 
#define SEN_COMPONENT_MAKER      senMakeKernelComponent      // NOLINT(cppcoreguidelines-macro-usage)
#define SEN_COMPONENT_INFO_MAKER senMakeKernelComponentInfo  // NOLINT(cppcoreguidelines-macro-usage)
 
namespace sen::kernel
{
 
constexpr auto* componentMakerFuncName = SEN_STRINGIFY(SEN_COMPONENT_MAKER);
constexpr auto* componentInfoMakerFuncName = SEN_STRINGIFY(SEN_COMPONENT_INFO_MAKER);
 
//--------------------------------------------------------------------------------------------------------------
// Component
//--------------------------------------------------------------------------------------------------------------
 
[[nodiscard]] constexpr bool getDebugEnabled() noexcept
{
#if defined(DEBUG) || defined(_DEBUG)
  return true;
#else
  return false;
#endif
}
 
[[nodiscard]] constexpr WordSize getWordSize() noexcept
{
  if constexpr (sizeof(size_t) == 4U)
  {
    return WordSize::bits32;
  }
  else
  {
    return WordSize::bits64;
  }
}
 
// Defined in the target's generated build_info.cpp, never here: inline over macros they put the
// git values on every compile line in the target, and those change every commit.
// SEN_PRIVATE so each binary resolves its own copy. Exported, a target with no build_info of
// its own links against the kernel's and reports the framework's hash as its own.
[[nodiscard]] SEN_PRIVATE const char* getGitRef() noexcept;
[[nodiscard]] SEN_PRIVATE const char* getGitHash() noexcept;
[[nodiscard]] SEN_PRIVATE GitStatus getGitStatus() noexcept;
 
// The commit's timestamp. A wall-clock build time is whenever the object was last recompiled,
// which is not the same thing.
[[nodiscard]] SEN_PRIVATE const char* getBuildTime() noexcept;
 
}  // namespace sen::kernel
 
// declare the functions that will be defined in the shared library
extern "C" SEN_EXPORT sen::kernel::Component* SEN_COMPONENT_MAKER();
extern "C" SEN_EXPORT const sen::kernel::ComponentInfo* SEN_COMPONENT_INFO_MAKER();

#define SEN_COMPONENT(component_name)                                                                                  \
                                                                                                                       \
  extern "C" SEN_EXPORT sen::kernel::Component* SEN_COMPONENT_MAKER()                                                  \
  {                                                                                                                    \
    return new component_name(); /* NOLINT(cppcoreguidelines-owning-memory) */                                         \
  }                                                                                                                    \
                                                                                                                       \
  extern "C" SEN_EXPORT const sen::kernel::ComponentInfo* SEN_COMPONENT_INFO_MAKER()                                   \
  {                                                                                                                    \
    static sen::kernel::ComponentInfo info {};                                                                         \
    info.name = SEN_TARGET_NAME;                                                                                       \
    info.description = SEN_TARGET_DESCRIPTION;                                                                         \
    info.buildInfo.maintainer = SEN_TARGET_MAINTAINER;                                                                 \
    info.buildInfo.version = SEN_TARGET_VERSION;                                                                       \
    info.buildInfo.compiler = SEN_COMPILER_STRING;                                                                     \
    info.buildInfo.debugMode = sen::kernel::getDebugEnabled();                                                         \
    info.buildInfo.wordSize = sen::kernel::getWordSize();                                                              \
    info.buildInfo.buildTime = sen::kernel::getBuildTime();                                                            \
    info.buildInfo.gitRef = sen::kernel::getGitRef();                                                                  \
    info.buildInfo.gitHash = sen::kernel::getGitHash();                                                                \
    info.buildInfo.gitStatus = sen::kernel::getGitStatus();                                                            \
    return &info;                                                                                                      \
  }
 
#endif  // SEN_KERNEL_COMPONENT_H