turbohex 0.1.1

Interactive terminal hex-viewer with plugin-based decoders
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

//! Type definitions for application state, input modes, and decoder configuration.

/// Determines whether the user is selecting at byte or bit granularity.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum SelectionMode {
    /// Standard byte-level selection (default).
    Byte,
    /// Bit-level selection for sub-byte field inspection.
    Bit,
}

/// The current input mode of the application, controlling which key handler is active.
#[derive(Clone, Copy, PartialEq, Eq)]
pub enum InputMode {
    /// Default browsing mode with full navigation.
    Normal,
    /// Visual selection mode: arrow keys extend the selection from the anchor point.
    Selecting,
    /// Text input mode for the "goto offset" prompt.
    GotoOffset,
    /// Text input mode for byte pattern search.
    SearchInput,
    /// Modal help popup is displayed; any key dismisses it.
    Help,
    /// Decoder settings popup for enabling/disabling decoders and editing params.
    DecoderSettings,
    /// Inline text editing of a decoder parameter value.
    ParamEdit,
}

/// Describes the data type of a configurable decoder parameter.
#[derive(Clone, PartialEq, Eq)]
pub enum ParamType {
    /// Free-form string value.
    String,
    /// Integer value (validated on entry).
    Int,
    /// Boolean toggle (`"true"` / `"false"`).
    Bool,
    /// A fixed set of choices the user cycles through.
    Choice(Vec<std::string::String>),
}

/// A single configurable parameter exposed by a decoder plugin.
///
/// Decoders declare parameters via their `params()` export. Each parameter
/// has a name, type, default value, and a current value that the user can
/// modify through the decoder settings UI.
#[derive(Clone)]
pub struct DecoderParam {
    /// Display name of the parameter.
    pub name: String,
    /// The expected value type, used for validation and UI rendering.
    pub param_type: ParamType,
    /// The default value provided by the decoder plugin.
    #[allow(dead_code)]
    pub default: String,
    /// The current user-configured value (initialized to `default`).
    pub value: String,
}

/// Metadata and runtime state for a registered decoder.
///
/// Each decoder (built-in, Lua, or WASM) is tracked as a `DecoderInfo` entry
/// in the application state. Users can enable/disable decoders and modify
/// their parameters through the settings UI.
#[derive(Clone)]
pub struct DecoderInfo {
    /// Human-readable name of the decoder (e.g., `"Built-in"`, `"example"`).
    pub name: String,
    /// Where this decoder comes from.
    pub source: DecoderSource,
    /// Whether this decoder is currently active and will produce decode output.
    pub enabled: bool,
    /// User-configurable parameters for this decoder.
    pub params: Vec<DecoderParam>,
}

/// Identifies the origin of a decoder plugin.
#[derive(Clone, PartialEq, Eq)]
pub enum DecoderSource {
    /// The built-in decoder that ships with turbohex (integer, float, string, etc.).
    Builtin,
    /// A Lua script loaded from `~/.config/turbohex/decoders/*.lua`.
    Lua,
    /// A WASM module loaded from `~/.config/turbohex/decoders/*.wasm`.
    Wasm,
}