Plugin.h

#pragma once
 
 
#include <Foundation/Communication/Event.h>
#include <Foundation/Strings/String.h>
#include <Foundation/Strings/StringBuilder.h>
 
struct plPluginEvent
{
  enum Type
  {
    BeforeLoading,              
    AfterLoadingBeforeInit,     
    AfterLoading,               
    BeforeUnloading,            
    StartupShutdown,            
    AfterStartupShutdown,       
    AfterUnloading,             
    BeforePluginChanges,        
    AfterPluginChanges,         
  };
 
  Type m_EventType;             
  plStringView m_sPluginBinary; 
};
 
struct plPluginLoadFlags
{
  using StorageType = plUInt8;
 
  enum Enum
  {
    LoadCopy = PL_BIT(0),         
    PluginIsOptional = PL_BIT(1), 
    CustomDependency = PL_BIT(2), 
 
    Default = 0,
  };
 
  struct Bits
  {
    StorageType LoadCopy : 1;
    StorageType PluginIsOptional : 1;
  };
};
 
using plPluginInitCallback = void (*)();
 
class PL_FOUNDATION_DLL plPlugin
{
public:
  static const plCopyOnBroadcastEvent<const plPluginEvent&>& Events(); // [tested]
 
  static void InitializeStaticallyLinkedPlugins(); // [tested]
 
  static void BeginPluginChanges();
 
  static void EndPluginChanges();
 
  static bool ExistsPluginFile(plStringView sPluginFile);
 
  static plResult LoadPlugin(plStringView sPluginFile, plBitflags<plPluginLoadFlags> flags = plPluginLoadFlags::Default); // [tested]
 
  static void UnloadAllPlugins(); // [tested]
 
  static void SetMaxParallelInstances(plUInt32 uiMaxParallelInstances);
 
  struct PL_FOUNDATION_DLL Init
  {
    Init(plPluginInitCallback onLoadOrUnloadCB, bool bOnLoad);
    Init(const char* szAddPluginDependency);
  };
 
  struct PL_FOUNDATION_DLL PluginInfo
  {
    plString m_sName;
    plHybridArray<plString, 2> m_sDependencies;
    plBitflags<plPluginLoadFlags> m_LoadFlags;
  };
 
  static void GetAllPluginInfos(plDynamicArray<PluginInfo>& ref_infos);
 
  static void GetPluginPaths(plStringView sPluginName, plStringBuilder& ref_sOriginalFile, plStringBuilder& ref_sCopiedFile, plUInt8 uiFileCopyNumber);
 
  static bool PlatformNeedsPluginCopy();
 
private:
  plPlugin() = delete;
};
 
#define PL_PLUGIN_DEPENDENCY(PluginName) \
  plPlugin::Init PL_PP_CONCAT(PL_PP_CONCAT(plugin_dep_, PluginName), PL_SOURCE_LINE)(PL_PP_STRINGIFY(PluginName))
 
#define PL_PLUGIN_ON_LOADED()                                \
  static void plugin_OnLoaded();                             \
  plPlugin::Init plugin_OnLoadedInit(plugin_OnLoaded, true); \
  static void plugin_OnLoaded()
 
#define PL_PLUGIN_ON_UNLOADED()                                   \
  static void plugin_OnUnloaded();                                \
  plPlugin::Init plugin_OnUnloadedInit(plugin_OnUnloaded, false); \
  static void plugin_OnUnloaded()