///|
/// High-level application facade for ordinary Proton apps.
struct App {
file_path : String?
auto_config : Bool
mut window : @manifest.WindowManifest
mut entry : @manifest.AppEntry
windows : Array[@manifest.AppWindowManifest]
mut debug_level_value : Int
mut headless_value : Bool
mut title_overridden : Bool
mut size_overridden : Bool
mut titlebar_style_overridden : Bool
mut entry_overridden : Bool
mut debug_overridden : Bool
mut bridge_startup_timeout_value_ms : Int
mut menu : @native.MenuBar?
extension_settings : Map[String, @manifest.ExtensionSetting]
command_extensions : Map[String, @proton_command.AppCommandExtensionSpec]
command_registrars : Array[(@proton_command.CommandRegistrar) -> Unit raise]
application_lifecycle_hooks : Array[ApplicationLifecycleHook]
launch_input_handlers : Array[async (RuntimeLaunchInput) -> Unit noraise]
window_lifecycle_hooks : Array[WindowLifecycleHook]
validation_errors : Array[AppConfigurationError]
}
///|
let default_bridge_startup_timeout_ms = 30000
///|
priv struct ResolvedAppConfig {
manifest : @manifest.AppManifest
}
///|
priv struct BridgeDispatchTask {
request_id : Int64
window : Int64
task : @async.Task[@native.BridgeResponse]
mut state : BridgeRequestLifecycleState
}
///|
priv struct RunningWindow {
id : String
window : @native.Window
policy : BridgePagePolicy
lifetime : WindowLifetime
mut closed : Bool
}
///|
priv struct WindowLifetime {
mut ready : Bool
mut closed : Bool
mut startup_error : AppRunError?
ready_signal : @async.CondVar
close_signal : @async.CondVar
}
///|
priv struct PlannedWindow {
id : String
window : @manifest.WindowManifest
entry : @manifest.AppEntry
}
///|
priv struct CommandHostRuntime {
host : @core.AppCommandHost
destroy_hooks : Array[CommandExtensionDestroyHook]
mut closed : Bool
}
///|
priv struct CommandExtensionDestroyHook {
extension_id : String
callback : () -> Unit raise
}
///|
priv struct BridgePagePolicy {
dev_origin : String?
request_timeout_ms : Int
}
///|
priv struct BridgeFrontendConfig {
extensions : Array[@native.BridgeExtensionConfig]
initialization_units : Array[@native.BridgeInitializationUnit]
}
///|
priv enum AppLifecycleState {
Constructing = 0
Starting = 1
Running = 2
Closing = 3
Draining = 4
Destroying = 5
Closed = 6
}
///|
priv enum AppWindowLifecycleState {
NotCreated = 0
Creating = 1
Live = 2
CloseRequested = 3
VisiblyClosed = 4
Destroying = 5
Destroyed = 6
}
///|
priv enum BridgeRequestLifecycleState {
Running = 0
Responding = 1
Completed = 2
Cancelled = 3
Stale = 4
} derive(Eq)
///|
priv struct AppLifecycle {
mut state : AppLifecycleState
mut window_state : AppWindowLifecycleState
}
///|
/// Failures while resolving and validating an application's configuration.
pub(all) suberror AppConfigurationError {
InvalidSetting(name~ : String, message~ : String)
Bootstrap(@bootstrap.BootstrapError)
ExtensionDependencyCycle(extension_id~ : String)
ExtensionUnavailable(
extension_id~ : String,
requested_by~ : String?,
state~ : String
)
ExtensionAdaptationFailed(
extension_id~ : String,
error~ : @proton_extension.ExtensionAdapterError
)
InvalidJavaScriptNamespace(js_namespace~ : String)
InvalidJavaScriptApi(js_namespace~ : String, api_name~ : String)
InvalidDevelopmentUrl(url~ : String, reason~ : String)
} derive(Debug)
///|
/// Failures while loading the application's initial document.
pub(all) suberror AppEntryError {
ReadFailed(path~ : String, detail~ : String)
NativeLoad(action~ : String, error~ : @native.NativeError)
ClosedDuringStartup
} derive(Debug)
///|
/// Failures in the MoonBit-side runtime wakeup source.
pub(all) suberror RuntimeWakeupError {
UnsupportedFeature(feature~ : String)
PipeCreateFailed(detail~ : String)
SourceOpenFailed(source~ : String, detail~ : String)
SourceClosed
MissingNotification
} derive(Debug)
///|
/// Failures while starting or stopping command extensions.
pub(all) suberror CommandExtensionLifecycleError {
ApplicationRegistrationFailed(detail~ : String)
RegistrationFailed(extension_id~ : String, detail~ : String)
DestroyFailed(extension_id~ : String, detail~ : String)
} derive(Debug)
///|
/// Failures produced by application or window lifecycle hooks.
pub(all) suberror LifecycleHookError {
ApplicationStart(index~ : Int, detail~ : String)
ApplicationShutdown(index~ : Int, detail~ : String)
WindowReady(index~ : Int, detail~ : String)
WindowClose(index~ : Int, detail~ : String)
} derive(Debug)
///|
/// A failure from one stage of best-effort application teardown.
pub(all) suberror AppCleanupError {
CommandExtension(CommandExtensionLifecycleError)
LifecycleHook(LifecycleHookError)
WindowDestroy(@native.NativeError)
RuntimeDestroy(@native.NativeError)
} derive(Debug)
///|
/// Failures produced while configuring, starting, or running an application.
pub(all) suberror AppRunError {
RunnerError(String)
ConfigurationError(AppConfigurationError)
NativeRuntimeError(action~ : String, error~ : @native.NativeError)
RuntimeWakeupError(RuntimeWakeupError)
CommandExtensionLifecycleError(CommandExtensionLifecycleError)
LifecycleHookError(LifecycleHookError)
EntryLoadError(AppEntryError)
BridgeStartupError(@native.BridgeDiagnostic)
BridgeRuntimeError(@native.BridgeDiagnostic)
CleanupFailed(primary~ : String?, failures~ : Array[AppCleanupError])
UnexpectedTaskFailure(detail~ : String)
} derive(Debug)