Code/Engine/Foundation/Configuration/StaticSubSystem.h - dev - redgpu/ezEngine

Code/Engine/Foundation/Configuration/StaticSubSystem.h
113 строк4 KB
Jan Krassnigg
Remove circular includes in Basics.h (#1318)
04 июн 2024, 22:07
04 июн 2024, 22:07dab7d29
#pragma once

/// \file

/// *** Example Subsystem declarations ***
///
/// EZ_BEGIN_SUBSYSTEM_DECLARATION(Foundation, ExampleSubSystem)
///
///  BEGIN_SUBSYSTEM_DEPENDENCIES
///    "SomeOtherSubSystem",
///    "SomeOtherSubSystem2"
///  END_SUBSYSTEM_DEPENDENCIES
///
///  ON_CORESYSTEMS_STARTUP
///  {
///    ezExampleSubSystem::BasicStartup();
///  }
///
///  ON_CORESYSTEMS_SHUTDOWN
///  {
///    ezExampleSubSystem::BasicShutdown();
///  }
///
///  ON_HIGHLEVELSYSTEMS_STARTUP
///  {
///    ezExampleSubSystem::EngineStartup();
///  }
///
///  ON_HIGHLEVELSYSTEMS_SHUTDOWN
///  {
///    ezExampleSubSystem::EngineShutdown();
///  }
///
/// EZ_END_SUBSYSTEM_DECLARATION;

/// \brief Put this in some cpp file of a subsystem to start its startup / shutdown sequence declaration.
///
/// The first parameter is the name of the group, in which the subsystem resides, the second is the name of the subsystem itself.
#define EZ_BEGIN_SUBSYSTEM_DECLARATION(GroupName, SubsystemName) \
  class GroupName##SubsystemName##SubSystem;                     \
  class GroupName##SubsystemName##SubSystem : public ezSubSystem \
  {                                                              \
  public:                                                        \
    virtual ezStringView GetGroupName() const override           \
    {                                                            \
      return #GroupName;                                         \
    }                                                            \
                                                                 \
  public:                                                        \
    virtual ezStringView GetSubSystemName() const override       \
    {                                                            \
      return #SubsystemName;                                     \
    }

/// \brief Finishes a subsystem's startup / shutdown sequence declaration.
#define EZ_END_SUBSYSTEM_DECLARATION \
  }                                  \
  static EZ_PP_CONCAT(s_SubSystem, EZ_SOURCE_LINE)

/// \brief Defines what code is to be executed upon base startup.
///
/// Put this inside the subsystem declaration block.
#define ON_BASESYSTEMS_STARTUP \
private:                       \
  virtual void OnBaseSystemsStartup() override

/// \brief Defines what code is to be executed upon core startup.
///
/// Put this inside the subsystem declaration block.
#define ON_CORESYSTEMS_STARTUP \
private:                       \
  virtual void OnCoreSystemsStartup() override

/// \brief Defines what code is to be executed upon core shutdown.
///
/// Put this inside the subsystem declaration block.
#define ON_CORESYSTEMS_SHUTDOWN \
private:                        \
  virtual void OnCoreSystemsShutdown() override

/// \brief Defines what code is to be executed upon engine startup.
///
/// Put this inside the subsystem declaration block.
#define ON_HIGHLEVELSYSTEMS_STARTUP \
private:                            \
  virtual void OnHighLevelSystemsStartup() override

/// \brief Defines what code is to be executed upon engine shutdown.
///
/// Put this inside the subsystem declaration block.
#define ON_HIGHLEVELSYSTEMS_SHUTDOWN \
private:                             \
  virtual void OnHighLevelSystemsShutdown() override

/// \brief Begins the list of subsystems, on which the currently declared system depends on.
///
/// Must be followed by a series of strings with the names of the dependencies.
#define BEGIN_SUBSYSTEM_DEPENDENCIES                        \
public:                                                     \
  virtual ezStringView GetDependency(ezInt32 iDep) override \
  {                                                         \
    ezStringView szDeps[] = {

/// \brief Ends the list of subsystems, on which the currently declared system depends on.
#define END_SUBSYSTEM_DEPENDENCIES \
  , nullptr                        \
  }                                \
  ;                                \
  return szDeps[iDep];             \
  }

/// \brief This inserts a friend declaration into a class, such that the given group/subsystem can access private functions which it might need.
#define EZ_MAKE_SUBSYSTEM_STARTUP_FRIEND(GroupName, SubsystemName) friend class GroupName##SubsystemName##SubSystem;