editor_ui.hpp File Reference

#include <pulp/format/editor_assets.hpp>
#include <pulp/format/processor.hpp>
#include <pulp/runtime/alive_token.hpp>
#include <pulp/runtime/exceptions.hpp>
#include <pulp/runtime/log.hpp>
#include <pulp/state/store.hpp>
#include <pulp/view/auto_ui.hpp>
#include <pulp/view/scripted_ui.hpp>
#include <pulp/view/value_channel_set.hpp>
#include <atomic>
#include <filesystem>
#include <memory>
#include <optional>
#include <string>
#include <string_view>
#include <system_error>
#include <vector>

Go to the source code of this file.

Classes
struct	pulp::format::EditorUiInstance
struct	pulp::format::EditorUiSource
	Where the default scripted editor's document comes from. More...

Namespaces
namespace	pulp
namespace	pulp::format
	What the product grants a device: the quota table indexed by capability tier and live thermal state.

Typedefs
using	pulp::format::ScriptedEditorBuilder
	Builds the scripted editor from source, the document select_editor_ui_source() chose for assets (the caller has already checked it is available).

Functions
view::ValueChannelAccess	pulp::format::processor_value_channel_access (Processor &processor, runtime::AliveToken::Handle owner_alive)
	Build the UI-thread accessor used by scripted editors.
std::optional< std::filesystem::path >	pulp::format::configured_ui_script_path (const EditorAssets &assets)
	The on-disk scripted-UI entry file assets declares, if any.
std::optional< std::filesystem::path >	pulp::format::configured_ui_theme_path (const EditorAssets &assets)
	The on-disk theme / design-token file assets declares, if any.
std::vector< std::filesystem::path >	pulp::format::configured_ui_asset_roots (const EditorAssets &assets)
	The asset directories assets declares, split on '|'.
std::optional< std::filesystem::path >	pulp::format::configured_ui_script_path ()
	This binary's on-disk scripted-UI entry file (see register_editor_assets()).
std::optional< std::filesystem::path >	pulp::format::configured_ui_theme_path ()
	This binary's on-disk theme / design-token file.
std::vector< std::filesystem::path >	pulp::format::configured_ui_asset_roots ()
	This binary's asset directories.
std::vector< view::WidgetBridge::EmbeddedAsset >	pulp::format::embedded_ui_assets (const EditorAssets &assets)
	The files embedded beside assets' script, as the bridge consumes them.
EditorUiSource	pulp::format::select_editor_ui_source (const EditorAssets &assets, bool enable_hot_reload)
	Pick the document for a default scripted editor from the record the plug-in registered.
std::atomic< ScriptedEditorBuilder > &	pulp::format::scripted_editor_builder_slot () noexcept
	The scripted editor builder this binary links, or null.
EditorUiInstance	pulp::format::build_editor_ui_for_assets (const EditorAssets &assets, state::StateStore &store, bool enable_hot_reload, std::string *error, view::ValueChannelAccess value_channel_access, std::string_view storage_identity={})
	Build the editor assets declares: a scripted UI when it names or embeds a script and the binary links the scripted editor builder, AutoUi otherwise (or when the script fails to load).
EditorUiInstance	pulp::format::build_editor_ui_with_value_channel_access (state::StateStore &store, bool enable_hot_reload, std::string *error, view::ValueChannelAccess value_channel_access)
	The editor this binary declares (see register_editor_assets()).
EditorUiInstance	pulp::format::build_editor_ui (state::StateStore &store, bool enable_hot_reload, std::string *error=nullptr, view::ValueChannelSet *value_channels=nullptr)
	Compatibility entry point for stable processors and callers without a processor.