scripted_ui_prewarm.hpp

Go to the documentation of this file.

#pragma once
 
// Background preparation of a scripted editor's process-wide caches, so the
// host's view-creation call does not pay for the first parse of the UI.
//
// A hosted editor mounts its document inside the host's view-creation call
// (content-first open), and the first open in a process pays one-time costs
// there: QuickJS compiling the UI runtime and every inline script of a
// materialized document, and the decode + SHA-256 verification of that
// document. Both results are already kept process-wide (the script bytecode
// cache and the materialized document cache), so a plug-in can produce them
// before an editor is requested -- typically from its constructor, which a
// host runs when it instantiates the plug-in -- on a background thread that
// never touches a realm, a view or the audio thread.
//
// What it does NOT do: build views, run any script, or keep a realm alive.
// The per-open work (evaluating the runtime, laying out the tree, the first
// GPU frame) still happens in the view-creation call.
 
#include <atomic>
#include <chrono>
#include <cstdint>
#include <string>
#include <vector>
 
namespace pulp::view {
 
struct ScriptedUiPrewarmRequest {
    std::vector<std::string> scripts;
    std::vector<std::string> materialized_documents;
};

void prewarm_scripted_ui(ScriptedUiPrewarmRequest request);

using ScriptedUiPrewarmRunner = void (*)(ScriptedUiPrewarmRequest);
inline std::atomic<ScriptedUiPrewarmRunner>& scripted_ui_prewarm_runner() noexcept {
    static std::atomic<ScriptedUiPrewarmRunner> runner{nullptr};
    return runner;
}
 
struct ScriptedUiPrewarmStats {
    std::uint64_t requests = 0;            
    std::uint64_t scripts_compiled = 0;    
    std::uint64_t documents_verified = 0;  
    std::uint64_t documents_rejected = 0;  
    bool idle = true;                      
};
ScriptedUiPrewarmStats scripted_ui_prewarm_stats();

bool wait_for_scripted_ui_prewarm(std::chrono::milliseconds timeout);
 
}  // namespace pulp::view