ScriptModule.h

浏览该文件的文档.

#pragma once
 
#include "common/Export.h"
 
#include <cstdint>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <vector>
 
struct SQVM;
 
namespace eve::script {
 
enum class ScriptModuleStatus { NotHandled, Found, Error };
 
struct EVENGINE_API_FOUNDATION_INLINE ScriptModuleRequest {
    std::string importerUri;
    std::string specifier;
};
 
struct EVENGINE_API_FOUNDATION_INLINE ScriptModuleSource {
    std::string canonicalUri;
    std::string utf8Source;
    std::string contentHash;
    std::string debugOrigin;
};
 
class EVENGINE_API_FOUNDATION_INLINE IScriptModuleProvider {
public:
    virtual ~IScriptModuleProvider() = default;
 
    virtual ScriptModuleStatus resolve(const ScriptModuleRequest& request, std::string& canonicalUri,
                                       std::string& error) = 0;
    virtual ScriptModuleStatus load(std::string_view canonicalUri, ScriptModuleSource& source, std::string& error) = 0;
};
 
class EVENGINE_API_FOUNDATION ScriptModuleResolver {
public:
    using ProviderId = uint64_t;
 
    explicit ScriptModuleResolver(SQVM* vm);
    ~ScriptModuleResolver();
    ScriptModuleResolver(const ScriptModuleResolver&)            = delete;
    ScriptModuleResolver& operator=(const ScriptModuleResolver&) = delete;
 
    ProviderId registerProvider(std::shared_ptr<IScriptModuleProvider> provider, int priority = 0);
    bool unregisterProvider(ProviderId id);
    void registerDefaultProviders();
 
    void beginCompilation(std::string_view importerUri);
    [[nodiscard]] std::optional<std::string> takeCompilationFailure();
    void prepareDependencies(std::string_view importerUri);
    void instantiateDependencies(std::string_view importerUri);
    void invalidate(std::string_view canonicalUri);
    void reload(std::string_view canonicalUri);
    std::vector<std::string> reloadAffected(std::string_view canonicalUri);
    std::vector<std::string> dependencies(std::string_view importerUri) const;
    std::vector<std::string> reverseDependencies(std::string_view canonicalUri) const;
 
    static bool canonicalize(const ScriptModuleRequest& request, std::string& output, std::string& error);
 
private:
    struct Impl;
    std::unique_ptr<Impl> impl_;
};
 
}  // namespace eve::script