ratatui_ruby 1.0.0.pre.beta.2 → 1.0.0.pre.beta.3

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.
@@ -1,409 +0,0 @@
1
- // SPDX-FileCopyrightText: 2025 Kerrick Long <me@kerricklong.com>
2
- // SPDX-License-Identifier: AGPL-3.0-or-later
3
-
4
- use magnus::value::ReprValue;
5
- use magnus::{Error, Module};
6
- use ratatui::{
7
- backend::{CrosstermBackend, TestBackend},
8
- Terminal, TerminalOptions, Viewport,
9
- };
10
- use std::io;
11
- use std::sync::Mutex;
12
-
13
- pub enum TerminalWrapper {
14
- Crossterm(Terminal<CrosstermBackend<io::Stdout>>),
15
- Test(Terminal<TestBackend>),
16
- }
17
-
18
- pub static TERMINAL: Mutex<Option<TerminalWrapper>> = Mutex::new(None);
19
-
20
- pub fn init_terminal(
21
- focus_events: bool,
22
- bracketed_paste: bool,
23
- viewport_type: String,
24
- viewport_height: Option<u16>,
25
- ) -> Result<(), Error> {
26
- let ruby = magnus::Ruby::get().unwrap();
27
- let mut term_lock = TERMINAL.lock().unwrap();
28
- if term_lock.is_none() {
29
- let module = ruby.define_module("RatatuiRuby")?;
30
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
31
- let error_class = error_base.const_get("Terminal")?;
32
-
33
- // Parse viewport type
34
- let viewport = match viewport_type.as_str() {
35
- "inline" => {
36
- let height = viewport_height.unwrap_or(8);
37
- Viewport::Inline(height)
38
- }
39
- _ => Viewport::Fullscreen,
40
- };
41
-
42
- ratatui::crossterm::terminal::enable_raw_mode()
43
- .map_err(|e| Error::new(error_class, e.to_string()))?;
44
- let mut stdout = io::stdout();
45
-
46
- // Only enter alternate screen for fullscreen viewports
47
- if matches!(viewport, Viewport::Fullscreen) {
48
- ratatui::crossterm::execute!(
49
- stdout,
50
- ratatui::crossterm::terminal::EnterAlternateScreen
51
- )
52
- .map_err(|e| Error::new(error_class, e.to_string()))?;
53
- }
54
-
55
- ratatui::crossterm::execute!(stdout, ratatui::crossterm::event::EnableMouseCapture)
56
- .map_err(|e| Error::new(error_class, e.to_string()))?;
57
-
58
- if focus_events {
59
- ratatui::crossterm::execute!(stdout, ratatui::crossterm::event::EnableFocusChange)
60
- .map_err(|e| Error::new(error_class, e.to_string()))?;
61
- }
62
- if bracketed_paste {
63
- ratatui::crossterm::execute!(stdout, ratatui::crossterm::event::EnableBracketedPaste)
64
- .map_err(|e| Error::new(error_class, e.to_string()))?;
65
- }
66
-
67
- let backend = CrosstermBackend::new(stdout);
68
- let options = TerminalOptions { viewport };
69
- let terminal = Terminal::with_options(backend, options)
70
- .map_err(|e| Error::new(error_class, e.to_string()))?;
71
- *term_lock = Some(TerminalWrapper::Crossterm(terminal));
72
- }
73
- Ok(())
74
- }
75
-
76
- pub fn init_test_terminal(
77
- width: u16,
78
- height: u16,
79
- viewport_type: String,
80
- viewport_height: Option<u16>,
81
- ) -> Result<(), Error> {
82
- let ruby = magnus::Ruby::get().unwrap();
83
- let mut term_lock = TERMINAL.lock().unwrap();
84
- let backend = TestBackend::new(width, height);
85
- let module = ruby.define_module("RatatuiRuby")?;
86
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
87
- let error_class = error_base.const_get("Terminal")?;
88
-
89
- // Parse viewport type (same as init_terminal)
90
- let viewport = match viewport_type.as_str() {
91
- "inline" => {
92
- let vp_height = viewport_height.unwrap_or(height);
93
- Viewport::Inline(vp_height)
94
- }
95
- _ => Viewport::Fullscreen,
96
- };
97
-
98
- let options = TerminalOptions { viewport };
99
- let terminal = Terminal::with_options(backend, options)
100
- .map_err(|e| Error::new(error_class, e.to_string()))?;
101
- *term_lock = Some(TerminalWrapper::Test(terminal));
102
- Ok(())
103
- }
104
-
105
- pub fn restore_terminal() {
106
- let mut term_lock = TERMINAL.lock().unwrap();
107
- if let Some(wrapper) = term_lock.take() {
108
- match wrapper {
109
- TerminalWrapper::Crossterm(mut t) => {
110
- let _ = ratatui::crossterm::terminal::disable_raw_mode();
111
- let _ = ratatui::crossterm::execute!(
112
- t.backend_mut(),
113
- ratatui::crossterm::terminal::LeaveAlternateScreen,
114
- ratatui::crossterm::event::DisableMouseCapture,
115
- ratatui::crossterm::event::DisableFocusChange,
116
- ratatui::crossterm::event::DisableBracketedPaste
117
- );
118
- }
119
- TerminalWrapper::Test(_) => {}
120
- }
121
- }
122
- }
123
-
124
- pub fn get_buffer_content() -> Result<String, Error> {
125
- let ruby = magnus::Ruby::get().unwrap();
126
- let term_lock = TERMINAL.lock().unwrap();
127
- if let Some(TerminalWrapper::Test(terminal)) = term_lock.as_ref() {
128
- let buffer = terminal.backend().buffer();
129
- let area = buffer.area;
130
- let mut result = String::new();
131
- for y in 0..area.height {
132
- for x in 0..area.width {
133
- let cell = buffer.cell((x, y)).unwrap();
134
- result.push_str(cell.symbol());
135
- }
136
- result.push('\n');
137
- }
138
- Ok(result)
139
- } else {
140
- let module = ruby.define_module("RatatuiRuby")?;
141
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
142
- let error_class = error_base.const_get("Terminal")?;
143
- Err(Error::new(
144
- error_class,
145
- "Terminal is not initialized as TestBackend",
146
- ))
147
- }
148
- }
149
-
150
- pub fn insert_before(height: u16, _widget: magnus::Value) -> Result<(), Error> {
151
- let ruby = magnus::Ruby::get().unwrap();
152
- let mut term_lock = TERMINAL.lock().unwrap();
153
-
154
- if let Some(wrapper) = term_lock.as_mut() {
155
- let module = ruby.define_module("RatatuiRuby")?;
156
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
157
- let error_class = error_base.const_get("Terminal")?;
158
-
159
- match wrapper {
160
- TerminalWrapper::Crossterm(term) => {
161
- term.insert_before(height, |_buf| {})
162
- .map_err(|e| Error::new(error_class, e.to_string()))?;
163
- }
164
- TerminalWrapper::Test(term) => {
165
- term.insert_before(height, |_buf| {})
166
- .map_err(|e| Error::new(error_class, e.to_string()))?;
167
- }
168
- }
169
- Ok(())
170
- } else {
171
- let module = ruby.define_module("RatatuiRuby")?;
172
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
173
- let error_class = error_base.const_get("Terminal")?;
174
- Err(Error::new(error_class, "Terminal not initialized"))
175
- }
176
- }
177
-
178
- pub fn get_terminal_area() -> Result<magnus::RHash, Error> {
179
- let ruby = magnus::Ruby::get().unwrap();
180
- let mut term_lock = TERMINAL.lock().unwrap();
181
- if let Some(wrapper) = term_lock.as_mut() {
182
- let hash = ruby.hash_new();
183
- match wrapper {
184
- TerminalWrapper::Crossterm(term) => {
185
- // Call draw to capture the viewport area
186
- // draw() closure must return (), so we capture area in a mutable variable
187
- let mut captured_area = ratatui::layout::Rect::default();
188
- term.draw(|f| {
189
- captured_area = f.area();
190
- }).map_err(|e| {
191
- let module = ruby.define_module("RatatuiRuby").unwrap();
192
- let error_base = module.const_get::<_, magnus::RClass>("Error").unwrap();
193
- let error_class = error_base.const_get("Terminal").unwrap();
194
- Error::new(error_class, e.to_string())
195
- })?;
196
- hash.aset("x", captured_area.x)?;
197
- hash.aset("y", captured_area.y)?;
198
- hash.aset("width", captured_area.width)?;
199
- hash.aset("height", captured_area.height)?;
200
- }
201
- TerminalWrapper::Test(term) => {
202
- // Same for TestBackend
203
- let mut captured_area = ratatui::layout::Rect::default();
204
- term.draw(|f| {
205
- captured_area = f.area();
206
- }).map_err(|e| {
207
- let module = ruby.define_module("RatatuiRuby").unwrap();
208
- let error_base = module.const_get::<_, magnus::RClass>("Error").unwrap();
209
- let error_class = error_base.const_get("Terminal").unwrap();
210
- Error::new(error_class, e.to_string())
211
- })?;
212
- hash.aset("x", captured_area.x)?;
213
- hash.aset("y", captured_area.y)?;
214
- hash.aset("width", captured_area.width)?;
215
- hash.aset("height", captured_area.height)?;
216
- }
217
- }
218
- Ok(hash)
219
- } else {
220
- let module = ruby.define_module("RatatuiRuby")?;
221
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
222
- let error_class = error_base.const_get("Terminal")?;
223
- Err(Error::new(error_class, "Terminal is not initialized"))
224
- }
225
- }
226
-
227
- pub fn get_viewport_type() -> Result<String, Error> {
228
- let ruby = magnus::Ruby::get().unwrap();
229
- let mut term_lock = TERMINAL.lock().unwrap();
230
-
231
- if let Some(wrapper) = term_lock.as_mut() {
232
- match wrapper {
233
- TerminalWrapper::Crossterm(term) => {
234
- let vp_area = term.draw(|f| f.area()).map_err(|e| {
235
- let module = ruby.define_module("RatatuiRuby").unwrap();
236
- let error_base = module.const_get::<_, magnus::RClass>("Error").unwrap();
237
- let error_class = error_base.const_get("Terminal").unwrap();
238
- Error::new(error_class, e.to_string())
239
- })?;
240
- let backend_size = term.size().unwrap_or_default();
241
-
242
- if vp_area.height < backend_size.height {
243
- Ok("inline".to_string())
244
- } else {
245
- Ok("fullscreen".to_string())
246
- }
247
- }
248
- TerminalWrapper::Test(term) => {
249
- let vp_area = term.draw(|f| f.area()).map_err(|e| {
250
- let module = ruby.define_module("RatatuiRuby").unwrap();
251
- let error_base = module.const_get::<_, magnus::RClass>("Error").unwrap();
252
- let error_class = error_base.const_get("Terminal").unwrap();
253
- Error::new(error_class, e.to_string())
254
- })?;
255
- let backend_size = term.size().unwrap_or_default();
256
-
257
- if vp_area.height < backend_size.height {
258
- Ok("inline".to_string())
259
- } else {
260
- Ok("fullscreen".to_string())
261
- }
262
- }
263
- }
264
- } else {
265
- let module = ruby.define_module("RatatuiRuby")?;
266
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
267
- let error_class = error_base.const_get("Terminal")?;
268
- Err(Error::new(error_class, "Terminal not initialized"))
269
- }
270
- }
271
-
272
- pub fn get_cursor_position() -> Result<Option<(u16, u16)>, Error> {
273
- let ruby = magnus::Ruby::get().unwrap();
274
- let mut term_lock = TERMINAL.lock().unwrap();
275
- if let Some(TerminalWrapper::Test(terminal)) = term_lock.as_mut() {
276
- let module = ruby.define_module("RatatuiRuby")?;
277
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
278
- let error_class = error_base.const_get("Terminal")?;
279
- let pos = terminal
280
- .get_cursor_position()
281
- .map_err(|e| Error::new(error_class, e.to_string()))?;
282
- Ok(Some(pos.into()))
283
- } else {
284
- let module = ruby.define_module("RatatuiRuby")?;
285
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
286
- let error_class = error_base.const_get("Terminal")?;
287
- Err(Error::new(
288
- error_class,
289
- "Terminal is not initialized as TestBackend",
290
- ))
291
- }
292
- }
293
-
294
- pub fn resize_terminal(width: u16, height: u16) -> Result<(), Error> {
295
- let ruby = magnus::Ruby::get().unwrap();
296
- let mut term_lock = TERMINAL.lock().unwrap();
297
- if let Some(wrapper) = term_lock.as_mut() {
298
- match wrapper {
299
- TerminalWrapper::Crossterm(_) => {}
300
- TerminalWrapper::Test(terminal) => {
301
- terminal.backend_mut().resize(width, height);
302
- if let Err(e) = terminal.resize(ratatui::layout::Rect::new(0, 0, width, height)) {
303
- let module = ruby.define_module("RatatuiRuby")?;
304
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
305
- let error_class = error_base.const_get("Terminal")?;
306
- return Err(Error::new(error_class, e.to_string()));
307
- }
308
- }
309
- }
310
- }
311
- Ok(())
312
- }
313
-
314
- use magnus::Value;
315
-
316
- pub fn get_cell_at(x: u16, y: u16) -> Result<magnus::RHash, Error> {
317
- let ruby = magnus::Ruby::get().unwrap();
318
- let term_lock = TERMINAL.lock().unwrap();
319
- if let Some(TerminalWrapper::Test(terminal)) = term_lock.as_ref() {
320
- let buffer = terminal.backend().buffer();
321
- if let Some(cell) = buffer.cell((x, y)) {
322
- let hash = ruby.hash_new();
323
- hash.aset("char", cell.symbol())?;
324
- hash.aset("fg", color_to_value(cell.fg))?;
325
- hash.aset("bg", color_to_value(cell.bg))?;
326
- hash.aset("underline_color", color_to_value(cell.underline_color))?;
327
- hash.aset("modifiers", modifiers_to_value(cell.modifier))?;
328
- Ok(hash)
329
- } else {
330
- let module = ruby.define_module("RatatuiRuby")?;
331
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
332
- let error_class = error_base.const_get("Terminal")?;
333
- Err(Error::new(
334
- error_class,
335
- format!("Coordinates ({x}, {y}) out of bounds"),
336
- ))
337
- }
338
- } else {
339
- let module = ruby.define_module("RatatuiRuby")?;
340
- let error_base = module.const_get::<_, magnus::RClass>("Error")?;
341
- let error_class = error_base.const_get("Terminal")?;
342
- Err(Error::new(
343
- error_class,
344
- "Terminal is not initialized as TestBackend",
345
- ))
346
- }
347
- }
348
-
349
- fn color_to_value(color: ratatui::style::Color) -> Value {
350
- let ruby = magnus::Ruby::get().unwrap();
351
- match color {
352
- ratatui::style::Color::Reset => ruby.qnil().as_value(),
353
- ratatui::style::Color::Black => ruby.to_symbol("black").as_value(),
354
- ratatui::style::Color::Red => ruby.to_symbol("red").as_value(),
355
- ratatui::style::Color::Green => ruby.to_symbol("green").as_value(),
356
- ratatui::style::Color::Yellow => ruby.to_symbol("yellow").as_value(),
357
- ratatui::style::Color::Blue => ruby.to_symbol("blue").as_value(),
358
- ratatui::style::Color::Magenta => ruby.to_symbol("magenta").as_value(),
359
- ratatui::style::Color::Cyan => ruby.to_symbol("cyan").as_value(),
360
- ratatui::style::Color::Gray => ruby.to_symbol("gray").as_value(),
361
- ratatui::style::Color::DarkGray => ruby.to_symbol("dark_gray").as_value(),
362
- ratatui::style::Color::LightRed => ruby.to_symbol("light_red").as_value(),
363
- ratatui::style::Color::LightGreen => ruby.to_symbol("light_green").as_value(),
364
- ratatui::style::Color::LightYellow => ruby.to_symbol("light_yellow").as_value(),
365
- ratatui::style::Color::LightBlue => ruby.to_symbol("light_blue").as_value(),
366
- ratatui::style::Color::LightMagenta => ruby.to_symbol("light_magenta").as_value(),
367
- ratatui::style::Color::LightCyan => ruby.to_symbol("light_cyan").as_value(),
368
- ratatui::style::Color::White => ruby.to_symbol("white").as_value(),
369
- ratatui::style::Color::Rgb(r, g, b) => ruby
370
- .str_new(&(format!("#{r:02x}{g:02x}{b:02x}")))
371
- .as_value(),
372
- ratatui::style::Color::Indexed(i) => ruby.to_symbol(format!("indexed_{i}")).as_value(),
373
- }
374
- }
375
-
376
- fn modifiers_to_value(modifier: ratatui::style::Modifier) -> Value {
377
- let ruby = magnus::Ruby::get().unwrap();
378
- let ary = ruby.ary_new();
379
-
380
- if modifier.contains(ratatui::style::Modifier::BOLD) {
381
- let _ = ary.push(ruby.to_symbol("bold"));
382
- }
383
- if modifier.contains(ratatui::style::Modifier::ITALIC) {
384
- let _ = ary.push(ruby.to_symbol("italic"));
385
- }
386
- if modifier.contains(ratatui::style::Modifier::DIM) {
387
- let _ = ary.push(ruby.to_symbol("dim"));
388
- }
389
- if modifier.contains(ratatui::style::Modifier::UNDERLINED) {
390
- let _ = ary.push(ruby.to_symbol("underlined"));
391
- }
392
- if modifier.contains(ratatui::style::Modifier::REVERSED) {
393
- let _ = ary.push(ruby.to_symbol("reversed"));
394
- }
395
- if modifier.contains(ratatui::style::Modifier::HIDDEN) {
396
- let _ = ary.push(ruby.to_symbol("hidden"));
397
- }
398
- if modifier.contains(ratatui::style::Modifier::CROSSED_OUT) {
399
- let _ = ary.push(ruby.to_symbol("crossed_out"));
400
- }
401
- if modifier.contains(ratatui::style::Modifier::SLOW_BLINK) {
402
- let _ = ary.push(ruby.to_symbol("slow_blink"));
403
- }
404
- if modifier.contains(ratatui::style::Modifier::RAPID_BLINK) {
405
- let _ = ary.push(ruby.to_symbol("rapid_blink"));
406
- }
407
-
408
- ary.as_value()
409
- }