datui-lib 0.4.0

Data Exploration in the Terminal (library)
Documentation 
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209

use crate::config::Theme;
use crate::numfmt::NumberFormatSettings;
use ratatui::style::Color;

/// Snapshot of theme colors and display configuration for rendering.
/// Passed to widgets to avoid threading many individual parameters.
#[derive(Debug, Clone)]
pub struct RenderContext {
    pub keybind_hints: Color,
    pub keybind_labels: Color,
    pub controls_bg: Color,
    pub background: Color,
    pub text_primary: Color,
    pub text_secondary: Color,
    pub text_inverse: Color,
    pub dimmed: Color,
    pub label: Color,
    pub success: Color,
    pub warning: Color,
    pub error: Color,
    pub modal_border: Color,
    pub modal_border_active: Color,
    pub modal_border_error: Color,
    pub surface: Color,
    pub throbber: Color,
    pub primary_chart_series_color: Color,

    /// The accent: key chips, focused titles, the selection rail.
    pub accent: Color,
    /// A brighter accent for the section the cursor is in.
    pub accent_bright: Color,
    /// The wordmark gradient, first and last stop.
    pub gradient_start: Color,
    pub gradient_end: Color,

    pub table_header: Color,
    pub table_header_bg: Color,
    pub row_numbers: Color,
    pub column_separator: Color,
    pub alternate_row_color: Option<Color>,
    /// Tint under the row the cursor is on; `None` means the old reversed-video look.
    pub table_selected: Option<Color>,
    /// The cell a find landed on, from the theme's `find_match_style`.
    pub find_match: ratatui::style::Style,
    /// The column cursor: its cells' tint, and its header's and the current cell's.
    pub column_cursor: Option<Color>,
    pub cell_cursor: Option<Color>,
    /// Whether the data table shows its second header row of column types.
    pub dtype_row: bool,

    pub str_col: Color,
    pub int_col: Color,
    pub float_col: Color,
    pub bool_col: Color,
    pub temporal_col: Color,
    /// Placeholder color for binary-column cells. Applied regardless of `column_colors` since the
    /// `‹binary›` stub is a placeholder, not data.
    pub binary_col: Color,
    /// The hex view's bytes by class: 0x00, printable, whitespace, control, 0x80 to
    /// 0xFE, and 0xFF.
    pub hex_null: Color,
    pub hex_printable: Color,
    pub hex_whitespace: Color,
    pub hex_control: Color,
    pub hex_high: Color,
    pub hex_ff: Color,

    pub table_cell_padding: u16,
    pub column_colors: bool,
    /// Resolved number formatting, including the runtime `,` toggle state.
    pub number_format: NumberFormatSettings,
}

impl RenderContext {
    /// A context with default colors, for tests about layout rather than colour.
    #[cfg(test)]
    pub fn for_test() -> Self {
        let theme = Theme::from_config(&crate::config::ThemeConfig::default())
            .expect("default theme colors must resolve");
        Self::from_theme_and_config(&theme, 2, true, NumberFormatSettings::default())
    }

    /// Style of the row or item the cursor is on: the theme's tint, or reversed video
    /// when the theme asks for that.
    pub fn highlight_style(&self) -> ratatui::style::Style {
        match self.table_selected {
            Some(bg) => ratatui::style::Style::default().bg(bg),
            None => {
                ratatui::style::Style::default().add_modifier(ratatui::style::Modifier::REVERSED)
            }
        }
    }

    /// Style of the column cursor's cells, from the theme's helper.
    pub fn column_cursor_style(&self) -> ratatui::style::Style {
        crate::config::column_cursor_style(self.column_cursor)
    }

    /// Style of the column cursor's header and the current cell, from the theme's
    /// helper.
    pub fn cell_cursor_style(&self) -> ratatui::style::Style {
        crate::config::cell_cursor_style(self.cell_cursor)
    }

    /// A column type's color, from the palette the table uses, so a column reads
    /// the same wherever it is listed.
    pub fn type_color(&self, dtype: &polars::prelude::DataType) -> ratatui::style::Color {
        use polars::prelude::DataType as D;
        match dtype {
            D::String | D::Categorical(_, _) | D::Enum(_, _) => self.str_col,
            D::Int8 | D::Int16 | D::Int32 | D::Int64 | D::Int128 => self.int_col,
            D::UInt8 | D::UInt16 | D::UInt32 | D::UInt64 => self.int_col,
            D::Float32 | D::Float64 | D::Decimal(_, _) => self.float_col,
            D::Boolean => self.bool_col,
            D::Date | D::Datetime(_, _) | D::Duration(_) | D::Time => self.temporal_col,
            D::Binary | D::BinaryOffset => self.binary_col,
            _ => self.text_secondary,
        }
    }

    /// The same context with the type row switched on or off.
    pub fn with_dtype_row(mut self, on: bool) -> Self {
        self.dtype_row = on;
        self
    }

    /// Build render context from app theme and config.
    /// This is a snapshot; changes to theme won't affect this instance.
    pub fn from_theme_and_config(
        theme: &Theme,
        table_cell_padding: u16,
        column_colors: bool,
        number_format: NumberFormatSettings,
    ) -> Self {
        Self {
            keybind_hints: theme.get("chip_key"),
            keybind_labels: theme.get("chip_label"),
            controls_bg: theme.get("controls_bg"),
            background: theme.get("background"),
            text_primary: theme.get("text_primary"),
            text_secondary: theme.get("text_secondary"),
            text_inverse: theme.get("text_inverse"),
            dimmed: theme.get("dimmed"),
            label: theme.get("label"),
            success: theme.get("success"),
            warning: theme.get("warning"),
            error: theme.get("error"),
            modal_border: theme.get("modal_border"),
            modal_border_active: theme.get("modal_border_active"),
            modal_border_error: theme.get("modal_border_error"),
            surface: theme.get("surface"),
            throbber: theme.get("throbber"),
            primary_chart_series_color: theme.get("chart_1"),

            accent: theme.get("accent"),
            accent_bright: theme.get("accent_bright"),
            gradient_start: theme.get("gradient_start"),
            gradient_end: theme.get("gradient_end"),

            table_header: theme.get("table_header"),
            table_header_bg: theme.get("table_header_bg"),
            row_numbers: theme.get("table_row_numbers"),
            column_separator: theme.get("table_column_separator"),
            alternate_row_color: theme.get_optional("table_alternate_row"),
            table_selected: theme.get_optional("table_selected"),
            find_match: theme.find_match_style(),
            column_cursor: theme.get_optional("table_column_cursor"),
            cell_cursor: theme.get_optional("table_cell_cursor"),
            dtype_row: true,

            str_col: if column_colors {
                theme.get("type_str")
            } else {
                Color::Reset
            },
            int_col: if column_colors {
                theme.get("type_int")
            } else {
                Color::Reset
            },
            float_col: if column_colors {
                theme.get("type_float")
            } else {
                Color::Reset
            },
            bool_col: if column_colors {
                theme.get("type_bool")
            } else {
                Color::Reset
            },
            temporal_col: if column_colors {
                theme.get("type_temporal")
            } else {
                Color::Reset
            },
            binary_col: theme.get("type_binary"),
            hex_null: theme.get("hex_null"),
            hex_printable: theme.get("hex_printable"),
            hex_whitespace: theme.get("hex_whitespace"),
            hex_control: theme.get("hex_control"),
            hex_high: theme.get("hex_high"),
            hex_ff: theme.get("hex_ff"),

            table_cell_padding,
            column_colors,
            number_format,
        }
    }
}