ratatui_ruby 0.5.0 → 0.6.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/.builds/ruby-3.2.yml +1 -1
- data/.builds/ruby-3.3.yml +1 -1
- data/.builds/ruby-3.4.yml +1 -1
- data/.builds/ruby-4.0.0.yml +1 -1
- data/AGENTS.md +6 -0
- data/CHANGELOG.md +44 -7
- data/README.md +11 -4
- data/REUSE.toml +2 -7
- data/doc/application_architecture.md +84 -10
- data/doc/application_testing.md +75 -29
- data/doc/contributors/design/ruby_frontend.md +39 -3
- data/doc/contributors/design/rust_backend.md +1 -0
- data/doc/contributors/developing_examples.md +129 -44
- data/doc/contributors/examples_audit/p1_high.md +21 -0
- data/doc/contributors/examples_audit/p2_moderate.md +81 -0
- data/doc/contributors/examples_audit.md +41 -0
- data/doc/event_handling.md +11 -3
- data/doc/images/app_all_events.png +0 -0
- data/doc/images/app_color_picker.png +0 -0
- data/doc/images/app_login_form.png +0 -0
- data/doc/images/app_stateful_interaction.png +0 -0
- data/doc/images/verify_quickstart_dsl.png +0 -0
- data/doc/images/verify_quickstart_layout.png +0 -0
- data/doc/images/verify_quickstart_lifecycle.png +0 -0
- data/doc/images/verify_readme_usage.png +0 -0
- data/doc/images/widget_barchart_demo.png +0 -0
- data/doc/images/widget_block_demo.png +0 -0
- data/doc/images/widget_canvas_demo.png +0 -0
- data/doc/images/widget_cell_demo.png +0 -0
- data/doc/images/widget_center_demo.png +0 -0
- data/doc/images/widget_chart_demo.png +0 -0
- data/doc/images/widget_list_demo.png +0 -0
- data/doc/images/widget_overlay_demo.png +0 -0
- data/doc/images/widget_render.png +0 -0
- data/doc/images/widget_rich_text.png +0 -0
- data/doc/images/widget_scroll_text.png +0 -0
- data/doc/images/widget_sparkline_demo.png +0 -0
- data/doc/images/widget_table_demo.png +0 -0
- data/doc/images/widget_tabs_demo.png +0 -0
- data/doc/images/widget_text_width.png +0 -0
- data/doc/quickstart.md +69 -76
- data/doc/terminal_limitations.md +92 -0
- data/examples/app_all_events/README.md +45 -27
- data/examples/app_all_events/app.rb +38 -35
- data/examples/app_all_events/model/app_model.rb +157 -0
- data/examples/app_all_events/model/event_entry.rb +17 -0
- data/examples/app_all_events/model/msg.rb +37 -0
- data/examples/app_all_events/update.rb +73 -0
- data/examples/app_all_events/view/app_view.rb +8 -8
- data/examples/app_all_events/view/controls_view.rb +8 -6
- data/examples/app_all_events/view/counts_view.rb +12 -8
- data/examples/app_all_events/view/live_view.rb +8 -7
- data/examples/app_all_events/view/log_view.rb +10 -15
- data/examples/app_color_picker/README.md +84 -44
- data/examples/app_color_picker/app.rb +24 -62
- data/examples/app_color_picker/controls.rb +90 -0
- data/examples/app_color_picker/copy_dialog.rb +45 -49
- data/examples/app_color_picker/export_pane.rb +126 -0
- data/examples/app_color_picker/input.rb +99 -67
- data/examples/app_color_picker/main_container.rb +178 -0
- data/examples/app_color_picker/palette.rb +55 -26
- data/examples/app_login_form/README.md +47 -0
- data/examples/app_login_form/app.rb +2 -3
- data/examples/app_stateful_interaction/README.md +31 -0
- data/examples/app_stateful_interaction/app.rb +272 -0
- data/examples/timeout_demo.rb +43 -0
- data/examples/verify_quickstart_dsl/README.md +48 -0
- data/examples/verify_quickstart_dsl/app.rb +2 -0
- data/examples/verify_quickstart_layout/README.md +71 -0
- data/examples/verify_quickstart_layout/app.rb +2 -0
- data/examples/verify_quickstart_lifecycle/README.md +56 -0
- data/examples/verify_quickstart_lifecycle/app.rb +8 -2
- data/examples/verify_readme_usage/README.md +43 -0
- data/examples/verify_readme_usage/app.rb +8 -2
- data/examples/widget_barchart_demo/README.md +49 -0
- data/examples/widget_barchart_demo/app.rb +5 -5
- data/examples/widget_block_demo/README.md +34 -0
- data/examples/widget_block_demo/app.rb +256 -0
- data/examples/widget_box_demo/README.md +45 -0
- data/examples/widget_calendar_demo/README.md +39 -0
- data/examples/widget_canvas_demo/README.md +27 -0
- data/examples/widget_canvas_demo/app.rb +123 -0
- data/examples/widget_cell_demo/README.md +36 -0
- data/examples/widget_cell_demo/app.rb +31 -24
- data/examples/widget_center_demo/README.md +29 -0
- data/examples/widget_center_demo/app.rb +116 -0
- data/examples/widget_chart_demo/README.md +41 -0
- data/examples/widget_chart_demo/app.rb +7 -2
- data/examples/widget_gauge_demo/README.md +41 -0
- data/examples/widget_layout_split/README.md +44 -0
- data/examples/widget_line_gauge_demo/README.md +41 -0
- data/examples/widget_list_demo/README.md +49 -0
- data/examples/widget_list_demo/app.rb +91 -107
- data/examples/widget_map_demo/README.md +39 -0
- data/examples/{app_map_demo → widget_map_demo}/app.rb +2 -2
- data/examples/widget_overlay_demo/app.rb +248 -0
- data/examples/widget_popup_demo/README.md +36 -0
- data/examples/widget_ratatui_logo_demo/README.md +34 -0
- data/examples/widget_ratatui_mascot_demo/README.md +34 -0
- data/examples/widget_rect/README.md +38 -0
- data/examples/widget_render/README.md +37 -0
- data/examples/widget_rich_text/README.md +35 -0
- data/examples/widget_rich_text/app.rb +62 -33
- data/examples/widget_scroll_text/README.md +37 -0
- data/examples/widget_scroll_text/app.rb +0 -1
- data/examples/widget_scrollbar_demo/README.md +37 -0
- data/examples/widget_sparkline_demo/README.md +42 -0
- data/examples/widget_sparkline_demo/app.rb +4 -3
- data/examples/widget_style_colors/README.md +34 -0
- data/examples/widget_table_demo/README.md +48 -0
- data/examples/{app_table_select → widget_table_demo}/app.rb +46 -8
- data/examples/widget_tabs_demo/README.md +41 -0
- data/examples/widget_tabs_demo/app.rb +15 -1
- data/examples/widget_text_width/README.md +35 -0
- data/examples/widget_text_width/app.rb +106 -0
- data/exe/.gitkeep +0 -0
- data/ext/ratatui_ruby/Cargo.lock +11 -4
- data/ext/ratatui_ruby/Cargo.toml +2 -1
- data/ext/ratatui_ruby/src/events.rs +238 -26
- data/ext/ratatui_ruby/src/frame.rs +113 -1
- data/ext/ratatui_ruby/src/lib.rs +34 -4
- data/ext/ratatui_ruby/src/string_width.rs +101 -0
- data/ext/ratatui_ruby/src/terminal.rs +39 -15
- data/ext/ratatui_ruby/src/text.rs +1 -1
- data/ext/ratatui_ruby/src/widgets/barchart.rs +24 -6
- data/ext/ratatui_ruby/src/widgets/gauge.rs +9 -2
- data/ext/ratatui_ruby/src/widgets/line_gauge.rs +9 -2
- data/ext/ratatui_ruby/src/widgets/list.rs +179 -3
- data/ext/ratatui_ruby/src/widgets/list_state.rs +137 -0
- data/ext/ratatui_ruby/src/widgets/mod.rs +3 -0
- data/ext/ratatui_ruby/src/widgets/scrollbar.rs +93 -1
- data/ext/ratatui_ruby/src/widgets/scrollbar_state.rs +169 -0
- data/ext/ratatui_ruby/src/widgets/table.rs +113 -1
- data/ext/ratatui_ruby/src/widgets/table_state.rs +121 -0
- data/lib/ratatui_ruby/cell.rb +4 -4
- data/lib/ratatui_ruby/event/key/character.rb +35 -0
- data/lib/ratatui_ruby/event/key/media.rb +44 -0
- data/lib/ratatui_ruby/event/key/modifier.rb +95 -0
- data/lib/ratatui_ruby/event/key/navigation.rb +55 -0
- data/lib/ratatui_ruby/event/key/system.rb +45 -0
- data/lib/ratatui_ruby/event/key.rb +111 -51
- data/lib/ratatui_ruby/event/mouse.rb +3 -3
- data/lib/ratatui_ruby/event/paste.rb +1 -1
- data/lib/ratatui_ruby/frame.rb +96 -0
- data/lib/ratatui_ruby/list_state.rb +88 -0
- data/lib/ratatui_ruby/schema/bar_chart/bar.rb +2 -2
- data/lib/ratatui_ruby/schema/cursor.rb +5 -0
- data/lib/ratatui_ruby/schema/gauge.rb +3 -1
- data/lib/ratatui_ruby/schema/line_gauge.rb +2 -2
- data/lib/ratatui_ruby/schema/list.rb +25 -4
- data/lib/ratatui_ruby/schema/list_item.rb +41 -0
- data/lib/ratatui_ruby/schema/rect.rb +43 -0
- data/lib/ratatui_ruby/schema/style.rb +24 -4
- data/lib/ratatui_ruby/schema/table.rb +21 -3
- data/lib/ratatui_ruby/schema/text.rb +69 -1
- data/lib/ratatui_ruby/scrollbar_state.rb +112 -0
- data/lib/ratatui_ruby/session/autodoc.rb +65 -0
- data/lib/ratatui_ruby/session.rb +22 -7
- data/lib/ratatui_ruby/table_state.rb +90 -0
- data/lib/ratatui_ruby/test_helper/event_injection.rb +169 -0
- data/lib/ratatui_ruby/test_helper/snapshot.rb +390 -0
- data/lib/ratatui_ruby/test_helper/style_assertions.rb +351 -0
- data/lib/ratatui_ruby/test_helper/terminal.rb +127 -0
- data/lib/ratatui_ruby/test_helper/test_doubles.rb +68 -0
- data/lib/ratatui_ruby/test_helper.rb +65 -358
- data/lib/ratatui_ruby/version.rb +1 -1
- data/lib/ratatui_ruby.rb +42 -19
- data/sig/examples/app_stateful_interaction/app.rbs +33 -0
- data/sig/examples/widget_block_demo/app.rbs +32 -0
- data/sig/examples/{app_map_demo → widget_map_demo}/app.rbs +2 -2
- data/sig/examples/{app_table_select → widget_table_demo}/app.rbs +2 -2
- data/sig/examples/{widget_table_flex → widget_text_width}/app.rbs +2 -3
- data/sig/ratatui_ruby/event.rbs +11 -1
- data/sig/ratatui_ruby/frame.rbs +2 -0
- data/sig/ratatui_ruby/list_state.rbs +13 -0
- data/sig/ratatui_ruby/ratatui_ruby.rbs +2 -2
- data/sig/ratatui_ruby/schema/bar_chart/bar.rbs +3 -3
- data/sig/ratatui_ruby/schema/gauge.rbs +2 -2
- data/sig/ratatui_ruby/schema/line_gauge.rbs +2 -2
- data/sig/ratatui_ruby/schema/list.rbs +4 -2
- data/sig/ratatui_ruby/schema/list_item.rbs +10 -0
- data/sig/ratatui_ruby/schema/rect.rbs +3 -0
- data/sig/ratatui_ruby/schema/style.rbs +3 -3
- data/sig/ratatui_ruby/schema/table.rbs +3 -1
- data/sig/ratatui_ruby/schema/text.rbs +8 -6
- data/sig/ratatui_ruby/scrollbar_state.rbs +18 -0
- data/sig/ratatui_ruby/session.rbs +13 -0
- data/sig/ratatui_ruby/table_state.rbs +15 -0
- data/sig/ratatui_ruby/test_helper/event_injection.rbs +16 -0
- data/sig/ratatui_ruby/test_helper/snapshot.rbs +12 -0
- data/sig/ratatui_ruby/test_helper/style_assertions.rbs +64 -0
- data/sig/ratatui_ruby/test_helper/terminal.rbs +14 -0
- data/sig/ratatui_ruby/test_helper/test_doubles.rbs +22 -0
- data/sig/ratatui_ruby/test_helper.rbs +5 -4
- data/tasks/autodoc/examples.rb +79 -0
- data/tasks/autodoc/inventory.rb +9 -7
- data/tasks/autodoc.rake +11 -5
- data/tasks/bump/changelog.rb +3 -3
- data/tasks/bump/links.rb +67 -0
- data/tasks/sourcehut.rake +61 -21
- data/tasks/terminal_preview/app_screenshot.rb +13 -3
- data/tasks/terminal_preview/saved_screenshot.rb +4 -3
- metadata +111 -37
- data/doc/images/app_table_select.png +0 -0
- data/doc/images/widget_block_padding.png +0 -0
- data/doc/images/widget_block_titles.png +0 -0
- data/doc/images/widget_list_styles.png +0 -0
- data/examples/app_all_events/model/events.rb +0 -180
- data/examples/app_all_events/model/highlight.rb +0 -57
- data/examples/app_all_events/test/snapshots/after_focus_lost.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_focus_regained.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_horizontal_resize.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_key_a.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_key_ctrl_x.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_mouse_click.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_mouse_drag.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_multiple_events.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_paste.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_resize.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_right_click.txt +0 -24
- data/examples/app_all_events/test/snapshots/after_vertical_resize.txt +0 -24
- data/examples/app_all_events/test/snapshots/initial_state.txt +0 -24
- data/examples/app_all_events/view_state.rb +0 -42
- data/examples/app_color_picker/scene.rb +0 -201
- data/examples/widget_block_padding/app.rb +0 -67
- data/examples/widget_block_titles/app.rb +0 -69
- data/examples/widget_list_styles/app.rb +0 -141
- data/examples/widget_table_flex/app.rb +0 -95
- data/sig/examples/widget_block_padding/app.rbs +0 -11
- data/sig/examples/widget_block_titles/app.rbs +0 -11
- data/sig/examples/widget_list_styles/app.rbs +0 -11
- data/tasks/bump/comparison_links.rb +0 -41
- /data/doc/images/{app_map_demo.png → widget_map_demo.png} +0 -0
|
@@ -28,25 +28,120 @@ pub fn inject_test_event(event_type: String, data: magnus::RHash) -> Result<(),
|
|
|
28
28
|
Ok(())
|
|
29
29
|
}
|
|
30
30
|
|
|
31
|
+
/// Parses a `snake_case` string to `MediaKeyCode`.
|
|
32
|
+
///
|
|
33
|
+
/// Accepts both the new `media_`-prefixed codes (canonical) and the legacy
|
|
34
|
+
/// unprefixed codes for backward compatibility with existing tests.
|
|
35
|
+
fn parse_media_key(s: &str) -> Option<ratatui::crossterm::event::MediaKeyCode> {
|
|
36
|
+
use ratatui::crossterm::event::MediaKeyCode;
|
|
37
|
+
match s {
|
|
38
|
+
// New canonical codes (media_ prefix)
|
|
39
|
+
"media_play" | "play" => Some(MediaKeyCode::Play),
|
|
40
|
+
"media_pause" => Some(MediaKeyCode::Pause),
|
|
41
|
+
"media_play_pause" | "play_pause" => Some(MediaKeyCode::PlayPause),
|
|
42
|
+
"media_reverse" | "reverse" => Some(MediaKeyCode::Reverse),
|
|
43
|
+
"media_stop" | "stop" => Some(MediaKeyCode::Stop),
|
|
44
|
+
"media_fast_forward" | "fast_forward" => Some(MediaKeyCode::FastForward),
|
|
45
|
+
"media_rewind" | "rewind" => Some(MediaKeyCode::Rewind),
|
|
46
|
+
"media_track_next" | "track_next" => Some(MediaKeyCode::TrackNext),
|
|
47
|
+
"media_track_previous" | "track_previous" => Some(MediaKeyCode::TrackPrevious),
|
|
48
|
+
"media_record" | "record" => Some(MediaKeyCode::Record),
|
|
49
|
+
"media_lower_volume" | "lower_volume" => Some(MediaKeyCode::LowerVolume),
|
|
50
|
+
"media_raise_volume" | "raise_volume" => Some(MediaKeyCode::RaiseVolume),
|
|
51
|
+
"media_mute_volume" | "mute_volume" => Some(MediaKeyCode::MuteVolume),
|
|
52
|
+
_ => None,
|
|
53
|
+
}
|
|
54
|
+
}
|
|
55
|
+
|
|
56
|
+
/// Parses a `snake_case` string to `ModifierKeyCode`.
|
|
57
|
+
fn parse_modifier_key(s: &str) -> Option<ratatui::crossterm::event::ModifierKeyCode> {
|
|
58
|
+
use ratatui::crossterm::event::ModifierKeyCode;
|
|
59
|
+
match s {
|
|
60
|
+
"left_shift" => Some(ModifierKeyCode::LeftShift),
|
|
61
|
+
"left_control" => Some(ModifierKeyCode::LeftControl),
|
|
62
|
+
"left_alt" => Some(ModifierKeyCode::LeftAlt),
|
|
63
|
+
"left_super" => Some(ModifierKeyCode::LeftSuper),
|
|
64
|
+
"left_hyper" => Some(ModifierKeyCode::LeftHyper),
|
|
65
|
+
"left_meta" => Some(ModifierKeyCode::LeftMeta),
|
|
66
|
+
"right_shift" => Some(ModifierKeyCode::RightShift),
|
|
67
|
+
"right_control" => Some(ModifierKeyCode::RightControl),
|
|
68
|
+
"right_alt" => Some(ModifierKeyCode::RightAlt),
|
|
69
|
+
"right_super" => Some(ModifierKeyCode::RightSuper),
|
|
70
|
+
"right_hyper" => Some(ModifierKeyCode::RightHyper),
|
|
71
|
+
"right_meta" => Some(ModifierKeyCode::RightMeta),
|
|
72
|
+
"iso_level3_shift" => Some(ModifierKeyCode::IsoLevel3Shift),
|
|
73
|
+
"iso_level5_shift" => Some(ModifierKeyCode::IsoLevel5Shift),
|
|
74
|
+
_ => None,
|
|
75
|
+
}
|
|
76
|
+
}
|
|
77
|
+
|
|
31
78
|
fn parse_key_event(
|
|
32
79
|
data: magnus::RHash,
|
|
33
80
|
ruby: &magnus::Ruby,
|
|
34
81
|
) -> Result<ratatui::crossterm::event::Event, Error> {
|
|
82
|
+
use ratatui::crossterm::event::KeyCode;
|
|
83
|
+
|
|
35
84
|
let code_val: Value = data
|
|
36
85
|
.get(ruby.to_symbol("code"))
|
|
37
86
|
.ok_or_else(|| Error::new(ruby.exception_arg_error(), "Missing 'code' in key event"))?;
|
|
38
87
|
let code_str: String = String::try_convert(code_val)?;
|
|
39
88
|
let code = match code_str.as_str() {
|
|
40
|
-
|
|
41
|
-
"
|
|
42
|
-
"
|
|
43
|
-
"
|
|
44
|
-
"
|
|
45
|
-
|
|
46
|
-
"
|
|
47
|
-
"
|
|
48
|
-
|
|
49
|
-
|
|
89
|
+
// Arrow keys
|
|
90
|
+
"up" => KeyCode::Up,
|
|
91
|
+
"down" => KeyCode::Down,
|
|
92
|
+
"left" => KeyCode::Left,
|
|
93
|
+
"right" => KeyCode::Right,
|
|
94
|
+
// Common keys
|
|
95
|
+
"enter" => KeyCode::Enter,
|
|
96
|
+
"esc" => KeyCode::Esc,
|
|
97
|
+
"backspace" => KeyCode::Backspace,
|
|
98
|
+
"tab" => KeyCode::Tab,
|
|
99
|
+
"back_tab" => KeyCode::BackTab,
|
|
100
|
+
// Navigation keys
|
|
101
|
+
"home" => KeyCode::Home,
|
|
102
|
+
"end" => KeyCode::End,
|
|
103
|
+
"page_up" => KeyCode::PageUp,
|
|
104
|
+
"page_down" => KeyCode::PageDown,
|
|
105
|
+
"insert" => KeyCode::Insert,
|
|
106
|
+
"delete" => KeyCode::Delete,
|
|
107
|
+
// Lock keys
|
|
108
|
+
"caps_lock" => KeyCode::CapsLock,
|
|
109
|
+
"scroll_lock" => KeyCode::ScrollLock,
|
|
110
|
+
"num_lock" => KeyCode::NumLock,
|
|
111
|
+
// System keys
|
|
112
|
+
"print_screen" => KeyCode::PrintScreen,
|
|
113
|
+
"pause" => KeyCode::Pause,
|
|
114
|
+
"menu" => KeyCode::Menu,
|
|
115
|
+
"keypad_begin" => KeyCode::KeypadBegin,
|
|
116
|
+
"null" => KeyCode::Null,
|
|
117
|
+
// Dynamic parsing for media, modifiers, function keys, and characters
|
|
118
|
+
s => {
|
|
119
|
+
// Media keys (check first - "fast_forward" starts with 'f' but isn't F-key)
|
|
120
|
+
if let Some(m) = parse_media_key(s) {
|
|
121
|
+
KeyCode::Media(m)
|
|
122
|
+
}
|
|
123
|
+
// Modifier keys
|
|
124
|
+
else if let Some(m) = parse_modifier_key(s) {
|
|
125
|
+
KeyCode::Modifier(m)
|
|
126
|
+
}
|
|
127
|
+
// Function keys: f1, f2, ..., f12, etc.
|
|
128
|
+
else if let Some(num_str) = s.strip_prefix('f') {
|
|
129
|
+
if let Ok(n) = num_str.parse::<u8>() {
|
|
130
|
+
KeyCode::F(n)
|
|
131
|
+
} else {
|
|
132
|
+
// "f" alone or invalid suffix - treat as character
|
|
133
|
+
KeyCode::Char(s.chars().next().unwrap_or('\0'))
|
|
134
|
+
}
|
|
135
|
+
}
|
|
136
|
+
// Single character
|
|
137
|
+
else if s.len() == 1 {
|
|
138
|
+
KeyCode::Char(s.chars().next().unwrap())
|
|
139
|
+
}
|
|
140
|
+
// Unknown - default to Null
|
|
141
|
+
else {
|
|
142
|
+
KeyCode::Null
|
|
143
|
+
}
|
|
144
|
+
}
|
|
50
145
|
};
|
|
51
146
|
|
|
52
147
|
let mut modifiers = ratatui::crossterm::event::KeyModifiers::empty();
|
|
@@ -178,7 +273,7 @@ pub fn clear_events() {
|
|
|
178
273
|
EVENT_QUEUE.lock().unwrap().clear();
|
|
179
274
|
}
|
|
180
275
|
|
|
181
|
-
pub fn poll_event(ruby: &magnus::Ruby) -> Result<Value, Error> {
|
|
276
|
+
pub fn poll_event(ruby: &magnus::Ruby, timeout_val: Option<f64>) -> Result<Value, Error> {
|
|
182
277
|
let event = {
|
|
183
278
|
let mut queue = EVENT_QUEUE.lock().unwrap();
|
|
184
279
|
if queue.is_empty() {
|
|
@@ -204,14 +299,23 @@ pub fn poll_event(ruby: &magnus::Ruby) -> Result<Value, Error> {
|
|
|
204
299
|
return Ok(ruby.qnil().into_value_with(ruby));
|
|
205
300
|
}
|
|
206
301
|
|
|
207
|
-
if
|
|
208
|
-
|
|
209
|
-
|
|
302
|
+
if let Some(secs) = timeout_val {
|
|
303
|
+
// Timed poll: wait up to the specified duration
|
|
304
|
+
let duration = std::time::Duration::from_secs_f64(secs);
|
|
305
|
+
if ratatui::crossterm::event::poll(duration)
|
|
306
|
+
.map_err(|e| Error::new(ruby.exception_runtime_error(), e.to_string()))?
|
|
307
|
+
{
|
|
308
|
+
let event = ratatui::crossterm::event::read()
|
|
309
|
+
.map_err(|e| Error::new(ruby.exception_runtime_error(), e.to_string()))?;
|
|
310
|
+
handle_event(event)
|
|
311
|
+
} else {
|
|
312
|
+
Ok(ruby.qnil().into_value_with(ruby))
|
|
313
|
+
}
|
|
314
|
+
} else {
|
|
315
|
+
// Blocking: wait indefinitely for an event
|
|
210
316
|
let event = ratatui::crossterm::event::read()
|
|
211
317
|
.map_err(|e| Error::new(ruby.exception_runtime_error(), e.to_string()))?;
|
|
212
318
|
handle_event(event)
|
|
213
|
-
} else {
|
|
214
|
-
Ok(ruby.qnil().into_value_with(ruby))
|
|
215
319
|
}
|
|
216
320
|
}
|
|
217
321
|
|
|
@@ -226,26 +330,134 @@ fn handle_event(event: ratatui::crossterm::event::Event) -> Result<Value, Error>
|
|
|
226
330
|
}
|
|
227
331
|
}
|
|
228
332
|
|
|
333
|
+
/// Converts `MediaKeyCode` to `snake_case` string.
|
|
334
|
+
///
|
|
335
|
+
/// All media keys are consistently prefixed with `media_` to reflect that they
|
|
336
|
+
/// belong to the `KeyCode::Media(_)` variant in Crossterm. This allows Ruby's
|
|
337
|
+
/// "Smart Predicates" to provide DWIM behavior (e.g., `pause?` matching both
|
|
338
|
+
/// system and media pause).
|
|
339
|
+
fn media_key_to_string(m: ratatui::crossterm::event::MediaKeyCode) -> &'static str {
|
|
340
|
+
use ratatui::crossterm::event::MediaKeyCode;
|
|
341
|
+
match m {
|
|
342
|
+
MediaKeyCode::Play => "media_play",
|
|
343
|
+
MediaKeyCode::Pause => "media_pause",
|
|
344
|
+
MediaKeyCode::PlayPause => "media_play_pause",
|
|
345
|
+
MediaKeyCode::Reverse => "media_reverse",
|
|
346
|
+
MediaKeyCode::Stop => "media_stop",
|
|
347
|
+
MediaKeyCode::FastForward => "media_fast_forward",
|
|
348
|
+
MediaKeyCode::Rewind => "media_rewind",
|
|
349
|
+
MediaKeyCode::TrackNext => "media_track_next",
|
|
350
|
+
MediaKeyCode::TrackPrevious => "media_track_previous",
|
|
351
|
+
MediaKeyCode::Record => "media_record",
|
|
352
|
+
MediaKeyCode::LowerVolume => "media_lower_volume",
|
|
353
|
+
MediaKeyCode::RaiseVolume => "media_raise_volume",
|
|
354
|
+
MediaKeyCode::MuteVolume => "media_mute_volume",
|
|
355
|
+
}
|
|
356
|
+
}
|
|
357
|
+
|
|
358
|
+
/// Converts `ModifierKeyCode` to `snake_case` string.
|
|
359
|
+
fn modifier_key_to_string(m: ratatui::crossterm::event::ModifierKeyCode) -> &'static str {
|
|
360
|
+
use ratatui::crossterm::event::ModifierKeyCode;
|
|
361
|
+
match m {
|
|
362
|
+
ModifierKeyCode::LeftShift => "left_shift",
|
|
363
|
+
ModifierKeyCode::LeftControl => "left_control",
|
|
364
|
+
ModifierKeyCode::LeftAlt => "left_alt",
|
|
365
|
+
ModifierKeyCode::LeftSuper => "left_super",
|
|
366
|
+
ModifierKeyCode::LeftHyper => "left_hyper",
|
|
367
|
+
ModifierKeyCode::LeftMeta => "left_meta",
|
|
368
|
+
ModifierKeyCode::RightShift => "right_shift",
|
|
369
|
+
ModifierKeyCode::RightControl => "right_control",
|
|
370
|
+
ModifierKeyCode::RightAlt => "right_alt",
|
|
371
|
+
ModifierKeyCode::RightSuper => "right_super",
|
|
372
|
+
ModifierKeyCode::RightHyper => "right_hyper",
|
|
373
|
+
ModifierKeyCode::RightMeta => "right_meta",
|
|
374
|
+
ModifierKeyCode::IsoLevel3Shift => "iso_level3_shift",
|
|
375
|
+
ModifierKeyCode::IsoLevel5Shift => "iso_level5_shift",
|
|
376
|
+
}
|
|
377
|
+
}
|
|
378
|
+
|
|
229
379
|
fn handle_key_event(key: ratatui::crossterm::event::KeyEvent) -> Result<Value, Error> {
|
|
380
|
+
use ratatui::crossterm::event::KeyCode;
|
|
381
|
+
|
|
230
382
|
let ruby = magnus::Ruby::get().unwrap();
|
|
231
383
|
if key.kind != ratatui::crossterm::event::KeyEventKind::Press {
|
|
232
384
|
return Ok(ruby.qnil().into_value_with(&ruby));
|
|
233
385
|
}
|
|
234
386
|
let hash = ruby.hash_new();
|
|
235
387
|
hash.aset(ruby.to_symbol("type"), ruby.to_symbol("key"))?;
|
|
388
|
+
|
|
389
|
+
// Determine the kind (category) of the key
|
|
390
|
+
let kind = match key.code {
|
|
391
|
+
KeyCode::Char(_)
|
|
392
|
+
| KeyCode::Enter
|
|
393
|
+
| KeyCode::Tab
|
|
394
|
+
| KeyCode::Backspace
|
|
395
|
+
| KeyCode::BackTab
|
|
396
|
+
| KeyCode::Up
|
|
397
|
+
| KeyCode::Down
|
|
398
|
+
| KeyCode::Left
|
|
399
|
+
| KeyCode::Right
|
|
400
|
+
| KeyCode::Home
|
|
401
|
+
| KeyCode::End
|
|
402
|
+
| KeyCode::PageUp
|
|
403
|
+
| KeyCode::PageDown
|
|
404
|
+
| KeyCode::Insert
|
|
405
|
+
| KeyCode::Delete
|
|
406
|
+
| KeyCode::Null => "standard",
|
|
407
|
+
KeyCode::F(_) => "function",
|
|
408
|
+
KeyCode::Media(_) => "media",
|
|
409
|
+
KeyCode::Modifier(_) => "modifier",
|
|
410
|
+
KeyCode::Esc
|
|
411
|
+
| KeyCode::CapsLock
|
|
412
|
+
| KeyCode::ScrollLock
|
|
413
|
+
| KeyCode::NumLock
|
|
414
|
+
| KeyCode::PrintScreen
|
|
415
|
+
| KeyCode::Pause
|
|
416
|
+
| KeyCode::Menu
|
|
417
|
+
| KeyCode::KeypadBegin => "system",
|
|
418
|
+
};
|
|
419
|
+
|
|
236
420
|
let code = match key.code {
|
|
237
|
-
|
|
238
|
-
|
|
239
|
-
|
|
240
|
-
|
|
241
|
-
|
|
242
|
-
|
|
243
|
-
|
|
244
|
-
|
|
245
|
-
|
|
246
|
-
|
|
421
|
+
// Characters
|
|
422
|
+
KeyCode::Char(c) => c.to_string(),
|
|
423
|
+
// Arrow keys
|
|
424
|
+
KeyCode::Up => "up".to_string(),
|
|
425
|
+
KeyCode::Down => "down".to_string(),
|
|
426
|
+
KeyCode::Left => "left".to_string(),
|
|
427
|
+
KeyCode::Right => "right".to_string(),
|
|
428
|
+
// Common keys
|
|
429
|
+
KeyCode::Enter => "enter".to_string(),
|
|
430
|
+
KeyCode::Esc => "esc".to_string(),
|
|
431
|
+
KeyCode::Backspace => "backspace".to_string(),
|
|
432
|
+
KeyCode::Tab => "tab".to_string(),
|
|
433
|
+
KeyCode::BackTab => "back_tab".to_string(),
|
|
434
|
+
// Navigation keys
|
|
435
|
+
KeyCode::Home => "home".to_string(),
|
|
436
|
+
KeyCode::End => "end".to_string(),
|
|
437
|
+
KeyCode::PageUp => "page_up".to_string(),
|
|
438
|
+
KeyCode::PageDown => "page_down".to_string(),
|
|
439
|
+
KeyCode::Insert => "insert".to_string(),
|
|
440
|
+
KeyCode::Delete => "delete".to_string(),
|
|
441
|
+
// Function keys
|
|
442
|
+
KeyCode::F(n) => format!("f{n}"),
|
|
443
|
+
// Lock keys
|
|
444
|
+
KeyCode::CapsLock => "caps_lock".to_string(),
|
|
445
|
+
KeyCode::ScrollLock => "scroll_lock".to_string(),
|
|
446
|
+
KeyCode::NumLock => "num_lock".to_string(),
|
|
447
|
+
// System keys
|
|
448
|
+
KeyCode::PrintScreen => "print_screen".to_string(),
|
|
449
|
+
KeyCode::Pause => "pause".to_string(),
|
|
450
|
+
KeyCode::Menu => "menu".to_string(),
|
|
451
|
+
KeyCode::KeypadBegin => "keypad_begin".to_string(),
|
|
452
|
+
KeyCode::Null => "null".to_string(),
|
|
453
|
+
// Compound variants
|
|
454
|
+
KeyCode::Media(m) => media_key_to_string(m).to_string(),
|
|
455
|
+
KeyCode::Modifier(m) => modifier_key_to_string(m).to_string(),
|
|
247
456
|
};
|
|
457
|
+
|
|
248
458
|
hash.aset(ruby.to_symbol("code"), code)?;
|
|
459
|
+
hash.aset(ruby.to_symbol("kind"), ruby.to_symbol(kind))?;
|
|
460
|
+
|
|
249
461
|
let mut modifiers = Vec::new();
|
|
250
462
|
if key
|
|
251
463
|
.modifiers
|
|
@@ -18,11 +18,14 @@
|
|
|
18
18
|
//! The `'static` lifetime is a lie, but a safe one within these constraints.
|
|
19
19
|
|
|
20
20
|
use crate::rendering;
|
|
21
|
+
use crate::widgets;
|
|
21
22
|
use magnus::{prelude::*, Error, Value};
|
|
22
23
|
use ratatui::layout::Rect;
|
|
23
24
|
use ratatui::Frame;
|
|
24
25
|
use std::cell::UnsafeCell;
|
|
25
26
|
use std::ptr::NonNull;
|
|
27
|
+
use std::sync::atomic::{AtomicBool, Ordering};
|
|
28
|
+
use std::sync::Arc;
|
|
26
29
|
|
|
27
30
|
/// A wrapper around Ratatui's `Frame` that can be exposed to Ruby.
|
|
28
31
|
///
|
|
@@ -36,10 +39,17 @@ use std::ptr::NonNull;
|
|
|
36
39
|
/// 2. The Ruby VM is single-threaded (GVL), so the frame pointer is never accessed
|
|
37
40
|
/// from multiple threads simultaneously
|
|
38
41
|
/// 3. `RubyFrame` never escapes the draw callback scope
|
|
42
|
+
///
|
|
43
|
+
/// The `active` flag provides runtime safety by preventing use after the draw
|
|
44
|
+
/// callback completes. Without this, a user could store the frame and cause
|
|
45
|
+
/// undefined behavior by accessing it after the underlying pointer is invalid.
|
|
39
46
|
#[magnus::wrap(class = "RatatuiRuby::Frame")]
|
|
40
47
|
pub struct RubyFrame {
|
|
41
48
|
/// Pointer to the underlying frame. Valid only during the draw callback.
|
|
42
49
|
inner: UnsafeCell<NonNull<Frame<'static>>>,
|
|
50
|
+
/// Shared flag to invalidate the frame when the block finishes.
|
|
51
|
+
/// Set to `true` during draw, `false` immediately after yield returns.
|
|
52
|
+
active: Arc<AtomicBool>,
|
|
43
53
|
}
|
|
44
54
|
|
|
45
55
|
// SAFETY: RubyFrame is only used within Terminal::draw() callbacks, which are
|
|
@@ -49,12 +59,18 @@ unsafe impl Send for RubyFrame {}
|
|
|
49
59
|
impl RubyFrame {
|
|
50
60
|
/// Creates a new `RubyFrame` wrapping the given frame reference.
|
|
51
61
|
///
|
|
62
|
+
/// # Arguments
|
|
63
|
+
///
|
|
64
|
+
/// * `frame` - Mutable reference to the underlying Ratatui frame
|
|
65
|
+
/// * `active` - Shared atomic flag that controls frame validity
|
|
66
|
+
///
|
|
52
67
|
/// # Safety
|
|
53
68
|
///
|
|
54
69
|
/// The caller must ensure that:
|
|
55
70
|
/// 1. The `RubyFrame` does not outlive the frame reference
|
|
56
71
|
/// 2. No other mutable references to the frame exist while `RubyFrame` is in use
|
|
57
|
-
|
|
72
|
+
/// 3. The `active` flag is set to `false` after the draw callback completes
|
|
73
|
+
pub fn new(frame: &mut Frame<'_>, active: Arc<AtomicBool>) -> Self {
|
|
58
74
|
// SAFETY: We cast the frame pointer to 'static lifetime. This is safe because:
|
|
59
75
|
// - RubyFrame is only used within Terminal::draw() callbacks
|
|
60
76
|
// - The Ruby block completes before the callback returns
|
|
@@ -67,6 +83,26 @@ impl RubyFrame {
|
|
|
67
83
|
|
|
68
84
|
Self {
|
|
69
85
|
inner: UnsafeCell::new(static_ptr),
|
|
86
|
+
active,
|
|
87
|
+
}
|
|
88
|
+
}
|
|
89
|
+
|
|
90
|
+
/// Checks that the frame is still valid for use.
|
|
91
|
+
///
|
|
92
|
+
/// Returns `Ok(())` if the frame can be used, or an error if the draw
|
|
93
|
+
/// callback has already completed.
|
|
94
|
+
fn ensure_active(&self) -> Result<(), Error> {
|
|
95
|
+
if self.active.load(Ordering::Relaxed) {
|
|
96
|
+
Ok(())
|
|
97
|
+
} else {
|
|
98
|
+
let ruby = magnus::Ruby::get().unwrap();
|
|
99
|
+
let module = ruby.define_module("RatatuiRuby")?;
|
|
100
|
+
let error_base = module.const_get::<_, magnus::RClass>("Error")?;
|
|
101
|
+
let error_class = error_base.const_get("Safety")?;
|
|
102
|
+
Err(Error::new(
|
|
103
|
+
error_class,
|
|
104
|
+
"Frame cannot be used outside of the draw block",
|
|
105
|
+
))
|
|
70
106
|
}
|
|
71
107
|
}
|
|
72
108
|
|
|
@@ -74,10 +110,12 @@ impl RubyFrame {
|
|
|
74
110
|
///
|
|
75
111
|
/// This mirrors `frame.area()` in Rust Ratatui.
|
|
76
112
|
pub fn area(&self) -> Result<Value, Error> {
|
|
113
|
+
self.ensure_active()?;
|
|
77
114
|
let ruby = magnus::Ruby::get().unwrap();
|
|
78
115
|
|
|
79
116
|
// SAFETY: The frame pointer is valid for the duration of the draw callback.
|
|
80
117
|
// We only read from the frame, which is safe with an immutable reference.
|
|
118
|
+
// The ensure_active() check above guarantees we're still in the callback.
|
|
81
119
|
let area = unsafe { (*self.inner.get()).as_ref().area() };
|
|
82
120
|
|
|
83
121
|
// Create a Ruby Rect object
|
|
@@ -95,6 +133,8 @@ impl RubyFrame {
|
|
|
95
133
|
/// * `widget` - A Ruby widget object (e.g., `RatatuiRuby::Paragraph`)
|
|
96
134
|
/// * `area` - A Ruby `Rect` or hash-like object with `x`, `y`, `width`, `height`
|
|
97
135
|
pub fn render_widget(&self, widget: Value, area: Value) -> Result<(), Error> {
|
|
136
|
+
self.ensure_active()?;
|
|
137
|
+
|
|
98
138
|
// Parse the Ruby area into a Rust Rect
|
|
99
139
|
let x: u16 = area.funcall("x", ())?;
|
|
100
140
|
let y: u16 = area.funcall("y", ())?;
|
|
@@ -107,9 +147,81 @@ impl RubyFrame {
|
|
|
107
147
|
// 1. RubyFrame is only used within Terminal::draw() callbacks
|
|
108
148
|
// 2. Ruby's GVL ensures single-threaded access
|
|
109
149
|
// 3. No other code holds a reference to the frame during this call
|
|
150
|
+
// 4. ensure_active() above guarantees we're still in the callback
|
|
110
151
|
let frame = unsafe { (*self.inner.get()).as_mut() };
|
|
111
152
|
|
|
112
153
|
// Delegate to the existing render_node function
|
|
113
154
|
rendering::render_node(frame, rect, widget)
|
|
114
155
|
}
|
|
156
|
+
|
|
157
|
+
/// Renders a stateful widget at the specified area.
|
|
158
|
+
///
|
|
159
|
+
/// This mirrors `frame.render_stateful_widget(widget, area, &mut state)` in Rust Ratatui.
|
|
160
|
+
/// The State object is the single source of truth for selection and offset.
|
|
161
|
+
/// Widget properties (`selected_index`, `selected_row`, `offset`) are ignored.
|
|
162
|
+
///
|
|
163
|
+
/// # Arguments
|
|
164
|
+
///
|
|
165
|
+
/// * `widget` - A Ruby widget object (e.g., `RatatuiRuby::List`)
|
|
166
|
+
/// * `area` - A Ruby `Rect`
|
|
167
|
+
/// * `state` - A Ruby state object (e.g., `RatatuiRuby::ListState`)
|
|
168
|
+
pub fn render_stateful_widget(
|
|
169
|
+
&self,
|
|
170
|
+
widget: Value,
|
|
171
|
+
area: Value,
|
|
172
|
+
state: Value,
|
|
173
|
+
) -> Result<(), Error> {
|
|
174
|
+
self.ensure_active()?;
|
|
175
|
+
let ruby = magnus::Ruby::get().unwrap();
|
|
176
|
+
|
|
177
|
+
// Parse the Ruby area into a Rust Rect
|
|
178
|
+
let x: u16 = area.funcall("x", ())?;
|
|
179
|
+
let y: u16 = area.funcall("y", ())?;
|
|
180
|
+
let width: u16 = area.funcall("width", ())?;
|
|
181
|
+
let height: u16 = area.funcall("height", ())?;
|
|
182
|
+
let rect = Rect::new(x, y, width, height);
|
|
183
|
+
|
|
184
|
+
// SAFETY: The frame pointer is valid for the duration of the draw callback.
|
|
185
|
+
let frame = unsafe { (*self.inner.get()).as_mut() };
|
|
186
|
+
|
|
187
|
+
// SAFETY: Immediate conversion to owned string avoids GC-unsafe borrowed reference.
|
|
188
|
+
let widget_class = unsafe { widget.class().name() }.into_owned();
|
|
189
|
+
// SAFETY: Immediate conversion to owned string avoids GC-unsafe borrowed reference.
|
|
190
|
+
let state_class = unsafe { state.class().name() }.into_owned();
|
|
191
|
+
|
|
192
|
+
match (widget_class.as_str(), state_class.as_str()) {
|
|
193
|
+
("RatatuiRuby::List", "RatatuiRuby::ListState") => {
|
|
194
|
+
widgets::list::render_stateful(frame, rect, widget, state)
|
|
195
|
+
}
|
|
196
|
+
("RatatuiRuby::Table", "RatatuiRuby::TableState") => {
|
|
197
|
+
widgets::table::render_stateful(frame, rect, widget, state)
|
|
198
|
+
}
|
|
199
|
+
("RatatuiRuby::Scrollbar", "RatatuiRuby::ScrollbarState") => {
|
|
200
|
+
widgets::scrollbar::render_stateful(frame, rect, widget, state)
|
|
201
|
+
}
|
|
202
|
+
_ => Err(Error::new(
|
|
203
|
+
ruby.exception_arg_error(),
|
|
204
|
+
format!("Unsupported widget/state combination: {widget_class} with {state_class}"),
|
|
205
|
+
)),
|
|
206
|
+
}
|
|
207
|
+
}
|
|
208
|
+
|
|
209
|
+
/// Sets the cursor position in the terminal.
|
|
210
|
+
///
|
|
211
|
+
/// This mirrors `frame.set_cursor_position((x, y))` in Rust Ratatui.
|
|
212
|
+
/// Use this for text input fields to show the cursor at the correct location.
|
|
213
|
+
///
|
|
214
|
+
/// # Arguments
|
|
215
|
+
///
|
|
216
|
+
/// * `x` - Column position (0-indexed from left)
|
|
217
|
+
/// * `y` - Row position (0-indexed from top)
|
|
218
|
+
pub fn set_cursor_position(&self, x: u16, y: u16) -> Result<(), Error> {
|
|
219
|
+
self.ensure_active()?;
|
|
220
|
+
|
|
221
|
+
// SAFETY: The frame pointer is valid for the duration of the draw callback.
|
|
222
|
+
// ensure_active() above guarantees we're still in the callback.
|
|
223
|
+
let frame = unsafe { (*self.inner.get()).as_mut() };
|
|
224
|
+
frame.set_cursor_position((x, y));
|
|
225
|
+
Ok(())
|
|
226
|
+
}
|
|
115
227
|
}
|
data/ext/ratatui_ruby/src/lib.rs
CHANGED
|
@@ -13,6 +13,7 @@
|
|
|
13
13
|
mod events;
|
|
14
14
|
mod frame;
|
|
15
15
|
mod rendering;
|
|
16
|
+
mod string_width;
|
|
16
17
|
mod style;
|
|
17
18
|
mod terminal;
|
|
18
19
|
mod text;
|
|
@@ -67,10 +68,17 @@ fn draw(args: &[Value]) -> Result<(), Error> {
|
|
|
67
68
|
let mut draw_callback = |f: &mut ratatui::Frame<'_>| {
|
|
68
69
|
if block_given {
|
|
69
70
|
// New API: yield RubyFrame to block
|
|
70
|
-
|
|
71
|
+
// Create validity flag — set to true while the block is executing
|
|
72
|
+
let active = std::sync::Arc::new(std::sync::atomic::AtomicBool::new(true));
|
|
73
|
+
|
|
74
|
+
let ruby_frame = RubyFrame::new(f, active.clone());
|
|
71
75
|
if let Err(e) = ruby.yield_value::<_, Value>(ruby_frame) {
|
|
72
76
|
render_error = Some(e);
|
|
73
77
|
}
|
|
78
|
+
|
|
79
|
+
// Invalidate frame immediately after block returns
|
|
80
|
+
// This prevents use-after-free if user stored the frame object
|
|
81
|
+
active.store(false, std::sync::atomic::Ordering::Relaxed);
|
|
74
82
|
} else if let Some(tree_value) = tree {
|
|
75
83
|
// Legacy API: render tree to full area
|
|
76
84
|
if let Err(e) = rendering::render_node(f, f.area(), tree_value) {
|
|
@@ -82,12 +90,18 @@ fn draw(args: &[Value]) -> Result<(), Error> {
|
|
|
82
90
|
if let Some(wrapper) = term_lock.as_mut() {
|
|
83
91
|
match wrapper {
|
|
84
92
|
terminal::TerminalWrapper::Crossterm(term) => {
|
|
93
|
+
let module = ruby.define_module("RatatuiRuby")?;
|
|
94
|
+
let error_base = module.const_get::<_, magnus::RClass>("Error")?;
|
|
95
|
+
let error_class = error_base.const_get("Terminal")?;
|
|
85
96
|
term.draw(&mut draw_callback)
|
|
86
|
-
.map_err(|e| Error::new(
|
|
97
|
+
.map_err(|e| Error::new(error_class, e.to_string()))?;
|
|
87
98
|
}
|
|
88
99
|
terminal::TerminalWrapper::Test(term) => {
|
|
100
|
+
let module = ruby.define_module("RatatuiRuby")?;
|
|
101
|
+
let error_base = module.const_get::<_, magnus::RClass>("Error")?;
|
|
102
|
+
let error_class = error_base.const_get("Terminal")?;
|
|
89
103
|
term.draw(&mut draw_callback)
|
|
90
|
-
.map_err(|e| Error::new(
|
|
104
|
+
.map_err(|e| Error::new(error_class, e.to_string()))?;
|
|
91
105
|
}
|
|
92
106
|
}
|
|
93
107
|
} else {
|
|
@@ -114,10 +128,23 @@ fn init() -> Result<(), Error> {
|
|
|
114
128
|
let frame_class = m.define_class("Frame", ruby.class_object())?;
|
|
115
129
|
frame_class.define_method("area", method!(RubyFrame::area, 0))?;
|
|
116
130
|
frame_class.define_method("render_widget", method!(RubyFrame::render_widget, 2))?;
|
|
117
|
-
|
|
131
|
+
frame_class.define_method(
|
|
132
|
+
"render_stateful_widget",
|
|
133
|
+
method!(RubyFrame::render_stateful_widget, 3),
|
|
134
|
+
)?;
|
|
135
|
+
frame_class.define_method(
|
|
136
|
+
"set_cursor_position",
|
|
137
|
+
method!(RubyFrame::set_cursor_position, 2),
|
|
138
|
+
)?;
|
|
139
|
+
m.define_module_function("_poll_event", function!(events::poll_event, 1))?;
|
|
118
140
|
m.define_module_function("inject_test_event", function!(events::inject_test_event, 2))?;
|
|
119
141
|
m.define_module_function("clear_events", function!(events::clear_events, 0))?;
|
|
120
142
|
|
|
143
|
+
// Register State classes
|
|
144
|
+
widgets::list_state::register(&ruby, m)?;
|
|
145
|
+
widgets::table_state::register(&ruby, m)?;
|
|
146
|
+
widgets::scrollbar_state::register(&ruby, m)?;
|
|
147
|
+
|
|
121
148
|
// Test backend helpers
|
|
122
149
|
m.define_module_function(
|
|
123
150
|
"init_test_terminal",
|
|
@@ -151,6 +178,9 @@ fn init() -> Result<(), Error> {
|
|
|
151
178
|
// Tabs metrics
|
|
152
179
|
m.define_module_function("_tabs_width", function!(widgets::tabs::width, 1))?;
|
|
153
180
|
|
|
181
|
+
// Text measurement
|
|
182
|
+
m.define_module_function("_text_width", function!(string_width::text_width, 1))?;
|
|
183
|
+
|
|
154
184
|
Ok(())
|
|
155
185
|
}
|
|
156
186
|
|
|
@@ -0,0 +1,101 @@
|
|
|
1
|
+
// SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
|
|
2
|
+
// SPDX-License-Identifier: AGPL-3.0-or-later
|
|
3
|
+
|
|
4
|
+
use magnus::{prelude::*, Error, Value};
|
|
5
|
+
|
|
6
|
+
/// Calculate the display width of a string in terminal cells.
|
|
7
|
+
///
|
|
8
|
+
/// Handles unicode correctly, including:
|
|
9
|
+
/// - Regular ASCII characters: 1 cell each
|
|
10
|
+
/// - CJK characters: 2 cells each (full-width)
|
|
11
|
+
/// - Emoji: typically 2 cells each (varies by terminal)
|
|
12
|
+
/// - Combining marks and zero-width characters: 0 cells
|
|
13
|
+
///
|
|
14
|
+
/// This uses the same `unicode-width` crate that Ratatui uses internally.
|
|
15
|
+
///
|
|
16
|
+
/// Returns the total display width in cells (not bytes or characters).
|
|
17
|
+
pub fn text_width(string: Value) -> Result<usize, Error> {
|
|
18
|
+
let ruby = magnus::Ruby::get().unwrap();
|
|
19
|
+
|
|
20
|
+
let s: String = String::try_convert(string).map_err(|_| {
|
|
21
|
+
Error::new(
|
|
22
|
+
ruby.exception_type_error(),
|
|
23
|
+
"expected a String or object that converts to String",
|
|
24
|
+
)
|
|
25
|
+
})?;
|
|
26
|
+
|
|
27
|
+
// Use unicode_width's width calculation.
|
|
28
|
+
// This is the same mechanism Ratatui uses internally for Paragraph.line_width().
|
|
29
|
+
let width = s
|
|
30
|
+
.chars()
|
|
31
|
+
.map(|c| unicode_width::UnicodeWidthChar::width(c).unwrap_or(0))
|
|
32
|
+
.sum();
|
|
33
|
+
|
|
34
|
+
Ok(width)
|
|
35
|
+
}
|
|
36
|
+
|
|
37
|
+
#[cfg(test)]
|
|
38
|
+
mod tests {
|
|
39
|
+
use unicode_width::UnicodeWidthChar;
|
|
40
|
+
|
|
41
|
+
fn measure_width(s: &str) -> usize {
|
|
42
|
+
s.chars()
|
|
43
|
+
.map(|c| UnicodeWidthChar::width(c).unwrap_or(0))
|
|
44
|
+
.sum()
|
|
45
|
+
}
|
|
46
|
+
|
|
47
|
+
#[test]
|
|
48
|
+
fn test_ascii_width() {
|
|
49
|
+
// ASCII is 1 cell per character
|
|
50
|
+
assert_eq!(measure_width("hello"), 5);
|
|
51
|
+
assert_eq!(measure_width("Hello, World!"), 13);
|
|
52
|
+
}
|
|
53
|
+
|
|
54
|
+
#[test]
|
|
55
|
+
fn test_emoji_width() {
|
|
56
|
+
// Emoji typically take 2 cells
|
|
57
|
+
// 👍 is U+1F44D THUMBS UP SIGN, width 2
|
|
58
|
+
assert_eq!(measure_width("👍"), 2);
|
|
59
|
+
// 🌍 is U+1F30D EARTH GLOBE EUROPE-AFRICA, width 2
|
|
60
|
+
assert_eq!(measure_width("🌍"), 2);
|
|
61
|
+
// "Hello 👍" = 5 + 1 + 2 = 8
|
|
62
|
+
assert_eq!(measure_width("Hello 👍"), 8);
|
|
63
|
+
}
|
|
64
|
+
|
|
65
|
+
#[test]
|
|
66
|
+
fn test_cjk_width() {
|
|
67
|
+
// CJK characters are full-width, 2 cells each
|
|
68
|
+
// 你 (U+4F60) is width 2
|
|
69
|
+
assert_eq!(measure_width("你"), 2);
|
|
70
|
+
// 好 (U+597D) is width 2
|
|
71
|
+
assert_eq!(measure_width("好"), 2);
|
|
72
|
+
// "你好" should be 4
|
|
73
|
+
assert_eq!(measure_width("你好"), 4);
|
|
74
|
+
}
|
|
75
|
+
|
|
76
|
+
#[test]
|
|
77
|
+
fn test_mixed_width() {
|
|
78
|
+
// "a你b好" = 1 + 2 + 1 + 2 = 6
|
|
79
|
+
assert_eq!(measure_width("a你b好"), 6);
|
|
80
|
+
}
|
|
81
|
+
|
|
82
|
+
#[test]
|
|
83
|
+
fn test_empty_string() {
|
|
84
|
+
assert_eq!(measure_width(""), 0);
|
|
85
|
+
}
|
|
86
|
+
|
|
87
|
+
#[test]
|
|
88
|
+
fn test_spaces_and_punctuation() {
|
|
89
|
+
// Regular ASCII space and punctuation are 1 cell each
|
|
90
|
+
assert_eq!(measure_width("a b c"), 5);
|
|
91
|
+
assert_eq!(measure_width("!!!"), 3);
|
|
92
|
+
}
|
|
93
|
+
|
|
94
|
+
#[test]
|
|
95
|
+
fn test_combining_marks() {
|
|
96
|
+
// Zero-width marks don't add to width
|
|
97
|
+
// "a" + combining acute accent (U+0301)
|
|
98
|
+
let combining = "a\u{0301}";
|
|
99
|
+
assert_eq!(measure_width(combining), 1);
|
|
100
|
+
}
|
|
101
|
+
}
|