[Rust] TUI: ratatui

ratatui는 터미널 UI 프레임워크다.
GUI 없이 터미널 환경에서 이런저런 복잡한 제어기능을 다루고 싶을때 사용하면 된다.

설치

아래 디펜던시를 2개 추가해준다.

[dependencies]
crossterm = "0.27.0"
ratatui = "0.26.0"

Hello World 작성해보기

기본 코드 양이 조금 된다. 분석에 앞서서 복붙하고 실행부터 해보자.

use crossterm::{
    event::{self, KeyCode, KeyEventKind},
    terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
    ExecutableCommand,
};
use ratatui::{
    prelude::{CrosstermBackend, Stylize, Terminal},
    widgets::Paragraph,
};
use std::io::{stdout, Result};

fn main() -> Result<()> {
    stdout().execute(EnterAlternateScreen)?;
    enable_raw_mode()?;
    let mut terminal = Terminal::new(CrosstermBackend::new(stdout()))?;
    terminal.clear()?;

    loop {
        terminal.draw(|frame| {
            let area = frame.size();
            frame.render_widget(
                Paragraph::new("Hello Ratatui! (press 'q' to quit)")
                    .white()
                    .on_blue(),
                area,
            );
        })?;

        if event::poll(std::time::Duration::from_millis(16))? {
            if let event::Event::Key(key) = event::read()? {
                if key.kind == KeyEventKind::Press && key.code == KeyCode::Char('q') {
                    break;
                }
            }
        }
    }

    stdout().execute(LeaveAlternateScreen)?;
    disable_raw_mode()?;
    Ok(())
}

그럼 빌드 후 실행이 될 것이고, 전용 화면이 뜰 것이다.

그리고 q를 누르면 종료된다.

코드 살펴보기

뭐가 복잡해보이긴 하는데, 하나씩 뜯어보면 그렇게 어렵지는 않다.

1. 먼저 Alternate 스크린 모드로 진입한다. 이래야 입출력을 방해하지 않고 그래픽스런 렌더링을 잘 할 수 있다.

2. raw mode를 켜서 터미널의 입출력을 제한한다. 그래야 이 앱에서만 터미널을 마음대로 통제할 수 있다.

3. 그리고 터미널 백엔드를 생성한다. 이제부터 이걸로 통제를 할 수 있게 된다.

4. 현재 터미널을 청소한다.

그러면 그 다음에는 루프에 진입해서 렌더링 프로세스를 진행하게 된다.

1. 매 렌더링마다 draw로 모양을 그린다. 여기서는 상세히 다루지 않지만, 좌표기반으로 섬세하게 제어할 수도 있다.
   참조 https://ratatui.rs/concepts/layout/

2. 그리고 키 이벤트가 오되, 그게 q이면 루프를 종료해서 프로그램을 나가도록 해뒀다.
   참조 https://ratatui.rs/concepts/event-handling/

더 자세한 것은 문서를 참조한다.
https://ratatui.rs/introduction/

참조
https://ratatui.rs/highlights/v026/