qbrsh 0.2.0

A fast, keyboard-driven web browser
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105

//! The unified message type.
//!
//! Every source of change (commands, engine signals, async results) produces a
//! [`Msg`]. Messages are the only thing the dispatch loop consumes, and
//! [`crate::core::update::update`] is the only thing that interprets them.

use crate::core::command::Command;
use crate::core::key::Key;
use crate::core::state::{Capability, Config, TabId};

/// Correlates an asynchronous request (e.g. a JS evaluation) with its result.
#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
pub struct RequestId(pub u64);

/// Load lifecycle stages reported by the engine.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum LoadEvent {
    Started,
    Committed,
    Finished,
}

/// Why a JS evaluation was requested, so its result can be routed.
///
/// The engine only knows a [`RequestId`] and a raw result, so the purpose is
/// recorded in state when the effect is emitted and looked up when the result
/// arrives.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum JsPurpose {
    /// No result handling needed.
    FireAndForget,
    /// Result is the vertical scroll percentage (0-100).
    ReadScrollPercent,
    /// Result is the space-joined list of rendered hint labels.
    HintsShown,
    /// Result is the href of a followed hint, to open in a new tab.
    HintHref,
}

/// A single unit of change entering the core.
#[derive(Debug, Clone)]
pub enum Msg {
    /// A raw key press (Normal-mode input), resolved against the binding trie.
    Key(Key),
    /// A parsed command to execute.
    Command(Command),
    /// A load lifecycle transition for a tab.
    Load { tab: TabId, event: LoadEvent },
    /// A tab's page title changed.
    TitleChanged { tab: TabId, title: String },
    /// A tab's URI changed.
    UriChanged { tab: TabId, uri: String },
    /// A tab's estimated load progress changed (0.0-1.0).
    Progress { tab: TabId, fraction: f64 },
    /// The result of an asynchronous JS evaluation, correlated by id.
    JsResult {
        id: RequestId,
        tab: TabId,
        result: Result<String, String>,
    },
    /// The command-line input text was edited by the user.
    CommandLineChanged(String),
    /// Select the next completion candidate.
    CompletionNext,
    /// Select the previous completion candidate.
    CompletionPrev,
    /// Commit the highlighted completion candidate into the command line.
    CompletionApply,
    /// Asynchronous history completion results, tagged with the generation they
    /// were requested for and the command-line prefix to apply.
    HistoryCompletion {
        generation: u64,
        prefix: String,
        entries: Vec<(String, String)>,
    },
    /// An input element gained or lost focus in a tab (insert-mode auto switch).
    InputFocusChanged { tab: TabId, focused: bool },
    /// A tab's web content process terminated unexpectedly.
    Crashed { tab: TabId },
    /// The configuration file was reloaded from disk.
    ConfigLoaded(Config),
    /// A session's tab URLs were loaded from disk.
    SessionLoaded(Vec<String>),
    /// A plugin requested a status-bar message.
    PluginMessage(String),
    /// A plugin awaited a JavaScript evaluation in the active tab.
    PluginEvalRequest { id: u64, script: String },
    /// The result of a plugin's awaited JS evaluation, to resume the plugin.
    PluginEvalResult { id: u64, result: String },
    /// A page requested a capability whose policy is `ask`; the engine holds the
    /// request (keyed by `id`) until the user's decision resolves it.
    PermissionRequested {
        id: u64,
        host: String,
        capability: Capability,
    },
    /// An in-page search reported its match count (0 means no matches).
    FindResult { tab: TabId, matches: u32 },
    /// A download started; `filename` is its chosen destination name.
    DownloadStarted { id: u64, filename: String },
    /// A download finished, saved at `path`.
    DownloadFinished { id: u64, path: String },
    /// A download failed.
    DownloadFailed { id: u64, error: String },
}