Pulp 1.88.0
Cross-platform audio plugin framework
Loading...
Searching...
No Matches
pulp::format::Processor::EditorPrewarm Struct Reference

What a scripted editor evaluates every time it opens and that does not depend on the instance: the text of the scripts it loads through WidgetBridge::load_script() (its ScriptedUiSession's script file, a design or help script loaded after the mount) and the inputs it passes to __pulpRuntimeImport__(text, 'materialized-browser'), byte-identical. More...

#include <processor.hpp>

Public Member Functions

bool empty () const noexcept

Public Attributes

std::vector< std::string_view > scripts
std::vector< std::string_view > materialized_documents

Detailed Description

What a scripted editor evaluates every time it opens and that does not depend on the instance: the text of the scripts it loads through WidgetBridge::load_script() (its ScriptedUiSession's script file, a design or help script loaded after the mount) and the inputs it passes to __pulpRuntimeImport__(text, 'materialized-browser'), byte-identical.

When a host instantiates the plug-in, the format adapter hands this to a background worker that compiles the scripts and verifies the documents into the process-wide caches (see editor_prewarm.hpp), so the first editor open does not do that work inside the host's view-creation call. Asked at most once per plug-in bundle per process, on the host's instantiation thread, and never under a headless/CI environment, so keep it cheap: return views of embedded, static data. The views must stay valid for the life of the plug-in image. Default (editor_prewarm(), declared after editor_background()): nothing to prewarm.

Member Function Documentation

◆ empty()

bool pulp::format::Processor::EditorPrewarm::empty ( ) const
inlinenoexcept

Member Data Documentation

◆ materialized_documents

std::vector<std::string_view> pulp::format::Processor::EditorPrewarm::materialized_documents

◆ scripts

std::vector<std::string_view> pulp::format::Processor::EditorPrewarm::scripts

The documentation for this struct was generated from the following file:
  • /home/runner/work/pulp/pulp/core/format/include/pulp/format/processor.hpp