README
- ::equalCell::equal
- ::not_equalCell::not_equal
- ::to_reprCell::to_repr
- ::defaultCellAttrs::default
- ::equalCellAttrs::equal
- ::not_equalCellAttrs::not_equal
- ::to_reprCellAttrs::to_repr
- ::equalDamage::equal
- ::is_emptyDamage::is_empty
- ::not_equalDamage::not_equal
- ::to_reprDamage::to_repr
- ::equalTermColor::equal
- ::not_equalTermColor::not_equal
- ::to_reprTermColor::to_repr
- ::newTermRow::new
- ::runsTermRow::runs
- ::textTermRow::text
- ::backspaceTermScreen::backspace
- ::carriage_returnTermScreen::carriage_return
- ::clear_allTermScreen::clear_all
- ::colsTermScreen::cols
- ::current_attrsTermScreen::current_attrs
- ::cursor_colTermScreen::cursor_col
- ::cursor_columnTermScreen::cursor_column
- ::cursor_downTermScreen::cursor_down
- ::cursor_leftTermScreen::cursor_left
- ::cursor_lineTermScreen::cursor_line
- ::cursor_positionTermScreen::cursor_position
- ::cursor_rightTermScreen::cursor_right
- ::cursor_rowTermScreen::cursor_row
- ::cursor_upTermScreen::cursor_up
- ::cursor_visibleTermScreen::cursor_visible
- ::delete_charsTermScreen::delete_chars
- ::delete_linesTermScreen::delete_lines
- ::erase_cellsTermScreen::erase_cells
- ::erase_charsTermScreen::erase_chars
- ::erase_in_displayTermScreen::erase_in_display
- ::erase_in_lineTermScreen::erase_in_line
- ::insert_charsTermScreen::insert_chars
- ::insert_linesTermScreen::insert_lines
- ::line_atTermScreen::line_at
- ::linefeedTermScreen::linefeed
- ::newTermScreen::new
- ::print_charTermScreen::print_char
- ::putTermScreen::put
- ::resetTermScreen::reset
- ::resizeTermScreen::resize
- ::restore_cursorTermScreen::restore_cursor
- ::reverse_indexTermScreen::reverse_index
- ::revisionTermScreen::revision
- ::rowsTermScreen::rows
- ::save_cursorTermScreen::save_cursor
- ::scroll_downTermScreen::scroll_down
- ::scroll_upTermScreen::scroll_up
- ::set_auto_wrapTermScreen::set_auto_wrap
- ::set_current_attrsTermScreen::set_current_attrs
- ::set_cursor_visibleTermScreen::set_cursor_visible
- ::set_scroll_regionTermScreen::set_scroll_region
- ::set_scrollback_limitTermScreen::set_scrollback_limit
- ::set_titleTermScreen::set_title
- ::tabTermScreen::tab
- ::take_damageTermScreen::take_damage
- ::titleTermScreen::title
- ::total_linesTermScreen::total_lines
V
attrs_with
V
attrs_with_fg
V
blank_cell
V
continuation_cell
V
trim_trailing_spaces
V
unicode_width

moui_tui

Terminal cell model: colors, attributes, rows and a damage-tracked screen buffer

moui

tui

terminal

cell-buffer

damage

Download zip

Author

wzzc-dev

Version

0.1.1

License

Apache-2.0

Repository

github.com/wzzc-dev/MoUI.git

Last updated

9 hours ago

Downloads

wzzc-dev/moui_tui does not have a README file

Cell

source

pub(all) struct Cell {
  ch : String
  width : Int
  attrs : CellAttrs
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

单元格:一个字符(宽字符占两格,第二格为 continuation,ch 为空)。

Cell::equal

source

fn Cell::equal(Cell, Cell) -> Bool

Cell::not_equal

source

fn Cell::not_equal(x : Cell, y : Cell) -> Bool

Cell::to_repr

source

fn Cell::to_repr(Cell) -> @moonbitlang/core/debug.Repr
Repr

CellAttrs

source

pub(all) struct CellAttrs {
  fg : TermColor
  bg : TermColor
  bold : Bool
  dim : Bool
  italic : Bool
  underline : Bool
  reverse : Bool
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

单元格属性(SGR 状态)。

CellAttrs::default

source

fn CellAttrs::default() -> CellAttrs

CellAttrs::equal

source

fn CellAttrs::equal(CellAttrs, CellAttrs) -> Bool

CellAttrs::not_equal

source

fn CellAttrs::not_equal(x : CellAttrs, y : CellAttrs) -> Bool

CellAttrs::to_repr

source

fn CellAttrs::to_repr(CellAttrs) -> @moonbitlang/core/debug.Repr
Repr

Damage

source

pub(all) struct Damage {
  full : Bool
  rows : Array[Int]
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

一次呈现所需的最小脏信息:整屏重建,或按行增量。 rows 升序去重;由 TermScreen::take_damage 产出并随即清零。

Damage::equal

source

fn Damage::equal(Damage, Damage) -> Bool

Damage::is_empty

source

fn Damage::is_empty(self : Damage) -> Bool

Damage::not_equal

source

fn Damage::not_equal(x : Damage, y : Damage) -> Bool

Damage::to_repr

source

fn Damage::to_repr(Damage) -> @moonbitlang/core/debug.Repr
Repr

TermColor

source

pub(all) enum TermColor {
  Default
  Indexed(Int)
  Rgb(Int, Int, Int)
} derive(Eq, @moonbitlang/core/debug.Debug
Debug)

终端颜色:默认色、256 索引色、真彩色 RGB。

TermColor::equal

source

fn TermColor::equal(TermColor, TermColor) -> Bool

TermColor::not_equal

source

fn TermColor::not_equal(x : TermColor, y : TermColor) -> Bool

TermColor::to_repr

source

fn TermColor::to_repr(TermColor) -> @moonbitlang/core/debug.Repr
Repr

TermRow

source

pub(all) struct TermRow {
  cells : Array[Cell]
}

屏幕上一行。

TermRow::new

source

fn TermRow::new(cols : Int, attrs : CellAttrs) -> TermRow

TermRow::runs

source

fn TermRow::runs(self : TermRow) -> Array[(String, Int, CellAttrs)]

行内按连续相同属性合并的渲染 run:(文本, 占列数, 属性)。 continuation 单元格(width == 0)不产生文本。

TermRow::text

source

fn TermRow::text(self : TermRow) -> String

行文本(去掉尾部空白),供测试与标题提取使用。

TermScreen

source

pub struct TermScreen {
  // private fields
}

终端屏幕模型:可视区 + 回看缓冲 + 光标 + 滚动区域 + 脏行增量。只有单元格内容变化才标脏;光标移动、SGR 属性与滚动区域设置不算画面变化, 因此呈现器按 take_damage 输出即可覆盖残影,又不会重绘未变的行。

TermScreen::backspace

source

fn TermScreen::backspace(self : TermScreen) -> Unit

TermScreen::carriage_return

source

fn TermScreen::carriage_return(self : TermScreen) -> Unit

TermScreen::clear_all

source

fn TermScreen::clear_all(self : TermScreen) -> Unit

清空屏幕与回看缓冲。

TermScreen::cols

source

fn TermScreen::cols(self : TermScreen) -> Int

TermScreen::current_attrs

source

fn TermScreen::current_attrs(self : TermScreen) -> CellAttrs

TermScreen::cursor_col

source

fn TermScreen::cursor_col(self : TermScreen) -> Int

TermScreen::cursor_column

source

fn TermScreen::cursor_column(self : TermScreen, col : Int) -> Unit

光标列定位(1-based)。

TermScreen::cursor_down

source

fn TermScreen::cursor_down(self : TermScreen, n : Int) -> Unit

光标下移 n 行(不越过滚动区域底部)。

TermScreen::cursor_left

source

fn TermScreen::cursor_left(self : TermScreen, n : Int) -> Unit

TermScreen::cursor_line

source

fn TermScreen::cursor_line(self : TermScreen, row : Int) -> Unit

光标行定位(1-based)。

TermScreen::cursor_position

source

fn TermScreen::cursor_position(self : TermScreen, row : Int, col : Int) -> Unit

光标定位(row/col 均为 1-based)。

TermScreen::cursor_right

source

fn TermScreen::cursor_right(self : TermScreen, n : Int) -> Unit

TermScreen::cursor_row

source

fn TermScreen::cursor_row(self : TermScreen) -> Int

TermScreen::cursor_up

source

fn TermScreen::cursor_up(self : TermScreen, n : Int) -> Unit

光标上移 n 行(不越过滚动区域顶部)。

TermScreen::cursor_visible

source

fn TermScreen::cursor_visible(self : TermScreen) -> Bool

TermScreen::delete_chars

source

fn TermScreen::delete_chars(self : TermScreen, n : Int) -> Unit

删除光标处起 n 个字符(行内左移)。

TermScreen::delete_lines

source

fn TermScreen::delete_lines(self : TermScreen, n : Int) -> Unit

删除光标行起的 n 行(区域内),顶部行进入回看缓冲。

TermScreen::erase_cells

source

fn TermScreen::erase_cells(self : TermScreen, y : Int, from : Int, to : Int, attrs : CellAttrs) -> Unit

把第 y 行的 [from, to) 列擦成空白(越界裁剪),保持 attrs 的底色。

TermScreen::erase_chars

source

fn TermScreen::erase_chars(self : TermScreen, n : Int) -> Unit

擦除光标处起 n 个字符(置空白,不移动)。

TermScreen::erase_in_display

source

fn TermScreen::erase_in_display(self : TermScreen, mode : Int) -> Unit

清除显示:0 = 光标到末尾,1 = 开头到光标,2 = 整屏,3 = 整屏 + 回看。

TermScreen::erase_in_line

source

fn TermScreen::erase_in_line(self : TermScreen, mode : Int) -> Unit

清除行:0 = 光标到行尾,1 = 行首到光标,2 = 整行。

TermScreen::insert_chars

source

fn TermScreen::insert_chars(self : TermScreen, n : Int) -> Unit

光标处插入 n 个空白格(行内右移)。

TermScreen::insert_lines

source

fn TermScreen::insert_lines(self : TermScreen, n : Int) -> Unit

光标行插入 n 个空行(区域内),底部行进入回看缓冲。

TermScreen::line_at

source

fn TermScreen::line_at(self : TermScreen, idx : Int) -> TermRow

取第 idx 行(0 = 最早的回看行;total_lines - rows 起为可视区)。

TermScreen::linefeed

source

fn TermScreen::linefeed(self : TermScreen) -> Unit

LF / VT / FF / IND:光标下移,在滚动区域底部时向上滚动。

TermScreen::new

source

fn TermScreen::new(cols : Int, rows : Int) -> TermScreen

TermScreen::print_char

source

fn TermScreen::print_char(self : TermScreen, ch : String, width : Int) -> Unit

光标处写入字符;处理自动换行与宽字符(右半格填 continuation)。

TermScreen::put

source

fn TermScreen::put(self : TermScreen, y : Int, x : Int, ch : String, width : Int, attrs : CellAttrs) -> Bool

直接写入第 y 行第 x 列,不移动光标 —— 投影器按量化盒定位单元格。越界或宽字符放不下时返回 false,调用方据此记降级诊断。

TermScreen::reset

source

fn TermScreen::reset(self : TermScreen) -> Unit

重置到初始状态(保留尺寸)。

TermScreen::resize

source

fn TermScreen::resize(self : TermScreen, new_cols : Int, new_rows : Int) -> Unit

调整尺寸;行/列变化尽量保留内容,缩小后的行进入回看缓冲。尺寸变化会让所有行的列位置失效,因此整屏标脏。

TermScreen::restore_cursor

source

fn TermScreen::restore_cursor(self : TermScreen) -> Unit

TermScreen::reverse_index

source

fn TermScreen::reverse_index(self : TermScreen) -> Unit

RI:光标上移,在滚动区域顶部时向下滚动。

TermScreen::revision

source

fn TermScreen::revision(self : TermScreen) -> Int

缓冲区代数:任何内容变化都会递增,呈现器用它跳过无变化的帧。

TermScreen::rows

source

fn TermScreen::rows(self : TermScreen) -> Int

TermScreen::save_cursor

source

fn TermScreen::save_cursor(self : TermScreen) -> Unit

TermScreen::scroll_down

source

fn TermScreen::scroll_down(self : TermScreen, n : Int) -> Unit

滚动区域内向下滚动 n 行,底部行进入回看缓冲头部。

TermScreen::scroll_up

source

fn TermScreen::scroll_up(self : TermScreen, n : Int) -> Unit

滚动区域内向上滚动 n 行,顶部行进入回看缓冲。

TermScreen::set_auto_wrap

source

fn TermScreen::set_auto_wrap(self : TermScreen, v : Bool) -> Unit

DECAWM:关闭自动换行后,超宽字符停在最后一列而不是滚到新行。

TermScreen::set_current_attrs

source

fn TermScreen::set_current_attrs(self : TermScreen, attrs : CellAttrs) -> Unit

TermScreen::set_cursor_visible

source

fn TermScreen::set_cursor_visible(self : TermScreen, v : Bool) -> Unit

TermScreen::set_scroll_region

source

fn TermScreen::set_scroll_region(self : TermScreen, top : Int, bottom : Int) -> Unit

设置滚动区域(top/bottom 为 1-based)。

TermScreen::set_scrollback_limit

source

fn TermScreen::set_scrollback_limit(self : TermScreen, limit : Int) -> Unit

TermScreen::set_title

source

fn TermScreen::set_title(self : TermScreen, title : String) -> Unit

TermScreen::tab

source

fn TermScreen::tab(self : TermScreen) -> Unit

TermScreen::take_damage

source

fn TermScreen::take_damage(self : TermScreen) -> Damage

取出并清零脏区:整屏重建,或升序去重的脏行。

TermScreen::title

source

fn TermScreen::title(self : TermScreen) -> String

TermScreen::total_lines

source

fn TermScreen::total_lines(self : TermScreen) -> Int

回看行数 + 可视行数。

attrs_with

source

fn attrs_with(attrs : CellAttrs, fg? : TermColor?, bg? : TermColor?, bold? : Bool?, dim? : Bool?, italic? : Bool?, underline? : Bool?, reverse? : Bool?) -> CellAttrs

复制属性并替换部分字段(SGR 序列用)。

attrs_with_fg

source

fn attrs_with_fg(attrs : CellAttrs, fg : TermColor) -> CellAttrs

复制属性并替换前景色。

blank_cell

source

fn blank_cell(attrs : CellAttrs) -> Cell

continuation_cell

source

fn continuation_cell(attrs : CellAttrs) -> Cell

宽字符右半格:width == 0 让它不产生文本,只继承底色。

trim_trailing_spaces

source

fn trim_trailing_spaces(s : String) -> String

去掉字符串尾部空格(终端行文本用)。

unicode_width

source

fn unicode_width(ch : String) -> Int

简化 wcwidth:ASCII 1,常见宽字符区间 2,其余 1。组合符未合并进基字符格,按 1 计(投影器不区分带符与基符)。

Source Files

Site source Report issue Packages Build queue Skills Statistics

moui_tui

#Cell

#Cell::equal

#Cell::not_equal

#Cell::to_repr

#CellAttrs

#CellAttrs::default

#CellAttrs::equal

#CellAttrs::not_equal

#CellAttrs::to_repr

#Damage

#Damage::equal

#Damage::is_empty

#Damage::not_equal

#Damage::to_repr

#TermColor

#TermColor::equal

#TermColor::not_equal

#TermColor::to_repr

#TermRow

#TermRow::new

#TermRow::runs

#TermRow::text

#TermScreen

#TermScreen::backspace

#TermScreen::carriage_return

#TermScreen::clear_all

#TermScreen::cols

#TermScreen::current_attrs

#TermScreen::cursor_col

#TermScreen::cursor_column

#TermScreen::cursor_down

#TermScreen::cursor_left

#TermScreen::cursor_line

#TermScreen::cursor_position

#TermScreen::cursor_right

#TermScreen::cursor_row

#TermScreen::cursor_up

#TermScreen::cursor_visible

#TermScreen::delete_chars

#TermScreen::delete_lines

#TermScreen::erase_cells

#TermScreen::erase_chars

#TermScreen::erase_in_display

#TermScreen::erase_in_line

#TermScreen::insert_chars

#TermScreen::insert_lines

#TermScreen::line_at

#TermScreen::linefeed

#TermScreen::new

#TermScreen::print_char

#TermScreen::put

#TermScreen::reset

#TermScreen::resize

#TermScreen::restore_cursor

#TermScreen::reverse_index

#TermScreen::revision

#TermScreen::rows

#TermScreen::save_cursor

#TermScreen::scroll_down

#TermScreen::scroll_up

#TermScreen::set_auto_wrap

#TermScreen::set_current_attrs

#TermScreen::set_cursor_visible

#TermScreen::set_scroll_region

#TermScreen::set_scrollback_limit

#TermScreen::set_title

#TermScreen::tab

#TermScreen::take_damage

#TermScreen::title

#TermScreen::total_lines

#attrs_with

#attrs_with_fg

#blank_cell

#continuation_cell

#trim_trailing_spaces

#unicode_width

Source Files

Cell

Cell::equal

Cell::not_equal

Cell::to_repr

CellAttrs

CellAttrs::default

CellAttrs::equal

CellAttrs::not_equal

CellAttrs::to_repr

Damage

Damage::equal

Damage::is_empty

Damage::not_equal

Damage::to_repr

TermColor

TermColor::equal

TermColor::not_equal

TermColor::to_repr

TermRow

TermRow::new

TermRow::runs

TermRow::text

TermScreen

TermScreen::backspace

TermScreen::carriage_return

TermScreen::clear_all

TermScreen::cols

TermScreen::current_attrs

TermScreen::cursor_col

TermScreen::cursor_column

TermScreen::cursor_down

TermScreen::cursor_left

TermScreen::cursor_line

TermScreen::cursor_position

TermScreen::cursor_right

TermScreen::cursor_row

TermScreen::cursor_up

TermScreen::cursor_visible

TermScreen::delete_chars

TermScreen::delete_lines

TermScreen::erase_cells

TermScreen::erase_chars

TermScreen::erase_in_display

TermScreen::erase_in_line

TermScreen::insert_chars

TermScreen::insert_lines

TermScreen::line_at

TermScreen::linefeed

TermScreen::new

TermScreen::print_char

TermScreen::put

TermScreen::reset

TermScreen::resize

TermScreen::restore_cursor

TermScreen::reverse_index

TermScreen::revision

TermScreen::rows

TermScreen::save_cursor

TermScreen::scroll_down

TermScreen::scroll_up

TermScreen::set_auto_wrap

TermScreen::set_current_attrs

TermScreen::set_cursor_visible

TermScreen::set_scroll_region

TermScreen::set_scrollback_limit

TermScreen::set_title

TermScreen::tab

TermScreen::take_damage

TermScreen::title

TermScreen::total_lines

attrs_with

attrs_with_fg

blank_cell

continuation_cell

trim_trailing_spaces

unicode_width