Plugin.h

// Copyright (c) Stefano Cristiano
// SPDX-License-Identifier: MIT
#pragma once
#include "../Common/CompilerMacrosExport.h"
#ifndef SC_EXPORT_LIBRARY_PLUGIN
#define SC_EXPORT_LIBRARY_PLUGIN 0
#endif
#define SC_PLUGIN_LIBRARY_EXPORT SC_COMPILER_LIBRARY_EXPORT(SC_EXPORT_LIBRARY_PLUGIN)
 
#include "../Common/Assert.h"
#include "../Common/Function.h"
#include "../Common/IGrowableBufferStringPath.h"
#include "../Common/PlatformMacrosType.h"
#include "../Common/PrimitiveDefinitions.h"
#include "Internal/DynamicLibrary.h"
#include "PluginError.h"
namespace SC
{
SC_DECLARE_ASSERT_PROVIDER(PluginAssert, SC_PLUGIN_LIBRARY_EXPORT);
 
#define SC_PLUGIN_ASSERT_RELEASE(e)        SC_ASSERT_PROVIDER_RELEASE(SC::PluginAssert, e)
#define SC_PLUGIN_ASSERT_DEBUG(e)          SC_ASSERT_PROVIDER_DEBUG(SC::PluginAssert, e)
#define SC_PLUGIN_TRUST_RESULT(expression) SC_PLUGIN_ASSERT_RELEASE(expression)
 
struct PluginDefinition;
struct PluginScanner;
struct PluginFile;
struct PluginIdentity;
struct PluginDynamicLibrary;
struct PluginCompiler;
struct PluginCompilerEnvironment;
struct PluginSysroot;
struct PluginRegistry;
template <int N>
using FixedString       = detail::StringNativeFixed<N>;
using PluginIdentifier  = FixedString<64>;
using PluginBuildOption = FixedString<32>;
 
template <typename T, size_t N>
struct FixedVector
{
    constexpr size_t size() const { return numValues; }
    constexpr void   clear() { numValues = 0; }
 
    operator Span<const T>() const { return {values, numValues}; }
 
    template <typename U>
    [[nodiscard]] constexpr bool contains(const U& value, size_t* outIndex = nullptr) const
    {
        for (size_t idx = 0; idx < numValues; ++idx)
        {
            if (values[idx] == value)
            {
                if (outIndex)
                    *outIndex = idx;
                return true;
            }
        }
        return false;
    }
 
    [[nodiscard]] constexpr bool isEmpty() const { return numValues == 0; }
 
    [[nodiscard]] constexpr bool push_back(const T& value)
    {
        if (numValues < N)
        {
            values[numValues++] = value;
            return true;
        }
        return false;
    }
 
    constexpr T*       begin() { return values; }
    constexpr T*       end() { return values + numValues; }
    constexpr T&       operator[](size_t idx) { return values[idx]; }
    constexpr const T* begin() const { return values; }
    constexpr const T* end() const { return values + numValues; }
    constexpr const T& operator[](size_t idx) const { return values[idx]; }
 
  private:
    T      values[N];
    size_t numValues = 0;
};
 
 
 
struct PluginFile
{
    StringPath absolutePath; 
};
 
struct PluginIdentity
{
    PluginIdentifier identifier; 
    FixedString<64>  name;       
    FixedString<16>  version;    
 
    bool operator==(const PluginIdentity& other) const { return identifier.view() == other.identifier.view(); }
};
 
struct PluginDefinition
{
    PluginIdentity identity; 
 
    FixedString<256> description; 
    FixedString<64>  category;    
    StringPath       directory;   
 
    FixedVector<PluginIdentifier, 8>  dependencies; 
    FixedVector<PluginBuildOption, 8> build;        
    FixedVector<PluginFile, 10>       files;        
 
    PluginFile& getMainPluginFile() { return files[pluginFileIndex]; }
 
    const PluginFile& getMainPluginFile() const { return files[pluginFileIndex]; }
 
    [[nodiscard]] static bool find(StringSpan text, StringSpan& extracted);
 
    [[nodiscard]] static ResultPlugin parse(StringSpan text, PluginDefinition& pluginDefinition, bool& parsed);
 
    [[nodiscard]] static bool parse(StringSpan text, PluginDefinition& pluginDefinition);
 
    ResultPlugin getDynamicLibraryAbsolutePath(StringPath& fullDynamicPath) const;
 
    ResultPlugin getDynamicLibraryPDBAbsolutePath(StringPath& fullDynamicPath) const;
 
  private:
    size_t pluginFileIndex = 0;
    friend struct PluginScanner;
};
 
struct PluginScanner
{
    template <typename T>
    static ResultPlugin scanDirectory(StringSpan directory, Span<PluginDefinition> definitionsStorage,
                                      T& tempFileBuffer, Span<PluginDefinition>& foundDefinitions)
    {
        return scanDirectory(directory, definitionsStorage, GrowableBuffer<T>{tempFileBuffer}, foundDefinitions);
    }
 
  private:
    static ResultPlugin scanDirectory(StringSpan directory, Span<PluginDefinition> definitionsStorage,
                                      IGrowableBuffer&& tempFileBuffer, Span<PluginDefinition>& foundDefinitions);
    struct ScannerState;
};
 
struct PluginCompiler
{
    ResultPlugin compile(const PluginDefinition& definition, const PluginSysroot& sysroot,
                         const PluginCompilerEnvironment& environment, Span<char>& compilerLog) const;
 
    ResultPlugin link(const PluginDefinition& definition, const PluginSysroot& sysroot,
                      const PluginCompilerEnvironment& environment, StringSpan executablePath,
                      Span<char>& linkerLog) const;
 
    enum class Type
    {
        ClangCompiler,
        GnuCompiler,
        MicrosoftCompiler
    };
    Type       type = Type::ClangCompiler; 
    StringPath compilerPath;               
    StringPath linkerPath;                 
 
    FixedVector<StringPath, 8> includePaths; 
 
    FixedVector<StringPath, 8> compilerIncludePaths; 
    FixedVector<StringPath, 8> compilerLibraryPaths; 
 
    [[nodiscard]] static ResultPlugin findBestCompiler(PluginCompiler& compiler);
 
  private:
    mutable native_char_t buffer[4096];
 
    ResultPlugin compileFile(const PluginDefinition& definition, const PluginSysroot& sysroot,
                             const PluginCompilerEnvironment& compilerEnvironment, StringSpan sourceFile,
                             StringSpan objectFile, Span<char>& compilerLog) const;
    struct CompilerFinder;
};
 
struct PluginSysroot
{
    FixedVector<StringPath, 8> includePaths; 
    FixedVector<StringPath, 8> libraryPaths; 
 
    StringPath isysroot; 
 
    [[nodiscard]] static ResultPlugin findBestSysroot(PluginCompiler::Type compiler, PluginSysroot& sysroot);
};
 
struct PluginCompilerEnvironment
{
    StringSpan cFlags;
    StringSpan ldFlags;
 
  private:
    struct Internal;
    friend struct PluginCompiler;
};
struct PluginDynamicLibrary
{
    PluginDefinition     definition;     
    SystemDynamicLibrary dynamicLibrary; 
    TimeMs               lastLoadTime;   
    uint32_t             numReloads;     
 
    char       errorStorage[1024 * 8] = {}; 
    StringSpan lastErrorLog;                
 
    template <typename T>
    [[nodiscard]] bool queryInterface(T*& outInterface) const
    {
        if (pluginQueryInterface and instance != nullptr)
        {
            return pluginQueryInterface(instance, T::InterfaceHash, reinterpret_cast<void**>(&outInterface));
        }
        return false;
    }
 
    PluginDynamicLibrary();
 
  private:
    void* instance                      = nullptr;
    bool (*pluginInit)(void*& instance) = nullptr;
    bool (*pluginClose)(void* instance) = nullptr;
 
    bool (*pluginQueryInterface)(void* instance, uint32_t hash, void** instanceInterface) = nullptr;
 
    friend struct PluginRegistry;
    ResultPlugin load(const PluginCompiler& compiler, const PluginSysroot& sysroot, StringSpan executablePath);
    ResultPlugin unload(bool releaseDebuggerFiles);
};
 
struct PluginRegistry
{
    void init(Span<PluginDynamicLibrary> librariesStorage);
 
    ResultPlugin close();
 
    ResultPlugin replaceDefinitions(Span<PluginDefinition>&& definitions);
 
    enum class LoadMode
    {
        Load   = 0,
        Reload = 1,
    };
 
    ResultPlugin loadPlugin(StringSpan identifier, const PluginCompiler& compiler, const PluginSysroot& sysroot,
                            StringSpan executablePath, LoadMode loadMode = LoadMode::Load);
 
    ResultPlugin unloadPlugin(StringSpan identifier);
 
    ResultPlugin removeAllBuildProducts(StringSpan identifier);
 
    [[nodiscard]] PluginDynamicLibrary* findPlugin(StringSpan identifier);
 
    [[nodiscard]] size_t getNumberOfEntries() const { return libraries.sizeInElements(); }
 
    [[nodiscard]] const PluginIdentifier& getIdentifierAt(size_t index) const
    {
        return libraries[index].definition.identity.identifier;
    }
 
    [[nodiscard]] const PluginDynamicLibrary& getPluginDynamicLibraryAt(size_t index) { return libraries[index]; }
 
    void getPluginsToReloadBecauseOf(StringSpan relativePath, TimeMs tolerance,
                                     Function<void(const PluginIdentifier&)> onPlugin);
 
  private:
    ResultPlugin unloadPlugin(StringSpan identifier, bool releaseDebuggerFiles);
 
    Span<PluginDynamicLibrary> storage;
    Span<PluginDynamicLibrary> libraries;
};
 
} // namespace SC