TTY

生の入力イベント、スタイル付き出力、レイアウトユーティリティ用のターミナル UI モジュール。

ロード

local tty = require("tty")

入力ループ

生の入力リーダーを起動し、イベントを購読し、ループで処理します：

local tty = require("tty")
local io = require("io")

local function handler()
    tty.start()
    local events = tty.events()

    while true do
        local ev = events:receive()
        if not ev then break end

        if ev.type == "key" then
            if ev.key == "q" or (ev.ctrl and ev.key == "c") then
                break
            end
            io.print("Key: " .. ev.key)

        elseif ev.type == "resize" then
            io.print("Size: " .. ev.width .. "x" .. ev.height)
        end
    end

    tty.stop()
end

入力制御

tty.start()

生のターミナル入力モードを有効にします。ターミナルは生モードへ切り替わり、イベントの送出を開始します。

local ok, err = tty.start()

戻り値: boolean, error

tty.stop()

生の入力を無効にし、ターミナルを通常モードへ戻します。

local ok, err = tty.stop()

戻り値: boolean, error

tty.events()

ターミナルイベントを購読し、チャネルを返します。イベントは type フィールドを持つテーブルとして配信されます。

local events = tty.events()

戻り値: EventChannel

tty.screen_size()

現在のターミナルの大きさを問い合わせます。

local width, height, err = tty.screen_size()

戻り値: number, number, error

tty.mouse(enable)

マウスイベントトラッキングを有効化または無効化します。

local ok, err = tty.mouse(true)

戻り値: boolean, error

イベント種別

イベントは type フィールドを持つテーブルで、それによってどの他のフィールドが存在するかが決まります。

キーイベント

{
    type = "key",
    key = "a",           -- 印刷可能文字またはキー名
    key_type = "runes",  -- 印刷可能の場合は "runes"、または特殊キー名
    action = "press",    -- "press" または "release"
    alt = false,
    ctrl = false,
    shift = false
}

マウスイベント

tty.mouse(true) が必要です。

{
    type = "mouse",
    action = "press",    -- "press"、"release"、"motion"、"wheel"
    button = "left",     -- ボタン名
    x = 10,
    y = 5,
    alt = false,
    ctrl = false,
    shift = false
}

リサイズイベント

{type = "resize", width = 120, height = 40}

スタートイベント

tty.start() 後に初期サイズとともに 1 度だけ送出されます。

{type = "start", width = 120, height = 40}

フォーカスイベント

{type = "focus", focused = true}

ペーストイベント

{type = "paste", text = "pasted content"}

キーバインディング

キーイベントに照合する再利用可能なキーバインディングを作成します：

local quit = tty.bind({
    keys = {"q", "ctrl+c"},
    help = {key = "q/ctrl+c", desc = "quit"}
})

-- イベントループ内
if quit:matches(ev) then
    break
end

tty.bind(config)

戻り値: KeyBinding

KeyBinding メソッド

スタイル

lipgloss ベースのスタイリングを使用してスタイル付きテキスト出力を作成します。すべてのスタイルメソッドは新しいスタイルを返します（不変）。

local tty = require("tty")
local io = require("io")

local title = tty.style()
    :bold()
    :foreground("#FF0000")
    :padding(0, 1)

local box = tty.style()
    :border(tty.borders.ROUNDED)
    :border_foreground("#00FF00")
    :width(40)
    :padding(1, 2)

io.print(box:render(title:render("Hello"), "World"))

tty.style()

新しい空のスタイルを作成します。

戻り値: Style

Style メソッド

すべてのメソッドは新しい Style を返し、チェーン可能です。

テキスト装飾

レイアウト

ボーダー

その他

ボーダー定数

tty.borders.NORMAL
tty.borders.ROUNDED
tty.borders.THICK
tty.borders.DOUBLE
tty.borders.HIDDEN

アライメント定数

tty.align.LEFT    -- 0
tty.align.CENTER  -- 0.5
tty.align.RIGHT   -- 1

テキストユーティリティ

スタイル付きテキスト用のレイアウトと計測関数。tty.text の下で利用可能です。

計測

local w = tty.text.width("hello")         -- 印刷可能幅（ANSI 対応）
local h = tty.text.height("a\nb\nc")      -- 行数
local w, h = tty.text.size("hello\nworld") -- 両方

結合

-- 横並びに結合、上揃え
local row = tty.text.join_horizontal(tty.text.position.TOP, left, right)

-- 縦に積む、中央揃え
local col = tty.text.join_vertical(tty.text.position.CENTER, top, bottom)

最大寸法

local w = tty.text.max_width({"short", "a longer string"})   -- 最も広いもの
local h = tty.text.max_height({"one\ntwo", "single"})         -- 最も高いもの

配置

指定された寸法のボックス内に文字列を配置します：

-- 80x24 のボックスの中央に配置
local out = tty.text.place(80, 24, tty.text.position.CENTER, tty.text.position.CENTER, content)

-- 水平方向のみ
local out = tty.text.place_horizontal(80, tty.text.position.RIGHT, content)

-- 垂直方向のみ
local out = tty.text.place_vertical(24, tty.text.position.BOTTOM, content)

ポジション定数

tty.text.position.TOP      -- 0
tty.text.position.LEFT     -- 0
tty.text.position.CENTER   -- 0.5
tty.text.position.BOTTOM   -- 1
tty.text.position.RIGHT    -- 1

関連項目

• ターミナル I/O — stdin/stdout/stderr 操作
• ターミナルホスト — ターミナルホスト設定