termletという小さな端末エミュレータをRustで作ってみました。ウィンドウが開いてシェルが動き、Emacsが普通に使えて、ホイールでスクロールバックを遡れる、というくらいのものです。大体1000行以下に収まっています。Linux専用です。

普段何気なく使っている端末エミュレータが、裏で何をしているのかが気になったのがきっかけです。実装はClaude Codeに教えてもらいながら進めました。

1000行に収まっているのは、端末エミュレータで一番大変な部分、つまりエスケープシーケンスの解釈と画面のグリッドの管理を自分では書いていないからです。そこはalacritty_terminalに任せていて、termletが書いているのはその周りだけです。この記事では、空のウィンドウを出すところから始めて、Emacsが動くまでを順番に見ていきます。

全体像

端末、カーネル、シェルの関係

termletの中身に入る前に、端末エミュレータとシェルがどうやってやり取りしているのかを整理しておきます。

端末エミュレータとシェルは直接はつながっていません。間にカーネルのPTY(擬似端末)があります。PTYはマスターとスレーブの2つの口を持つ双方向のパイプのようなもので、端末エミュレータがマスター側を持ち、シェルはスレーブ側を標準入力・標準出力・標準エラー出力にして動きます。シェルから見ると、スレーブは普通の端末デバイス(/dev/pts/N)です。

   termlet                    kernel (PTY)                      shell
+----------+     +--------------------------------------+     +-------+
| keyboard |---->| master --> line discipline --> slave |---->| read  |
|          |     |              (echo)                  |     |       |
| screen   |<----| master <-- line discipline <-- slave |<----| write |
+----------+     +--------------------------------------+     +-------+

マスターとスレーブの間には、line disciplineというカーネルの層が挟まっています。ここがいわゆる「端末らしい」処理をしている場所で、入力を1行ためてから渡す、打った文字をエコーする、Ctrl+Cでシグナルを送る、改行コードを変換する、といったことをやっています。どう振る舞うかは、sttyで見えるtermiosの設定で決まります。

例えば、プロンプトでecho 'hi'と打ってEnterを押したときに何が起きるかを追ってみます。ここではシェルがreadline(行編集)を使っていない、つまりline disciplineが行をためるモード(canonicalモード)で動いている場合を考えます。

  1. eのキーを押すと、termletはeという1バイトをマスターに書き込みます。termletはこの時点では画面に何も描きません
  2. line disciplineはeを自分の行バッファにためます。シェルはスレーブをread()したままブロックしていて、まだ何も受け取っていません
  3. ECHOが有効なので、line disciplineはeをマスター側に送り返します。termletはそれをマスターから読んで、画面にeを描きます。
  4. 残りのcho 'hi'も同じです。途中でBackspace(0x7f)を打つと、line disciplineが行バッファから1文字消して、画面上の文字を消すための\b \bをエコーします。ここまで、シェルは何も知りません
  5. Enterを押すと、termletは\rを書き込みます。line disciplineは\rを\nに変換して(ICRNL)、ここで1行がそろったので、シェルのread()がecho 'hi'\nを受け取って返ります。改行のエコーは\r\nになります(ONLCR)
  6. シェルはechoを実行してhi\nをスレーブに書きます。出力側でもline disciplineが\nを\r\nに変換し、termletはマスターからhi\r\nを読んで画面に描きます。続けてシェルが次のプロンプト$ を書きます

実際にPTYの上でbash --noeditingを動かして確かめると、eを書き込んだ時点でマスターからeが返ってきて、シェルはまだread()でブロックしたままでした。Enterを押したあとにマスターから読めたのは次のバイト列です。

\r\nhi\r\n$ 

改行のエコー、echoの出力、次のプロンプトの順に並んでいます。

Ctrl+Cもline disciplineが処理しています。termletは0x03を1バイト書くだけで、それを見たline disciplineが、その端末のフォアグラウンドのプロセスグループにSIGINTを送ります(ISIG)。どのプロセスに送るかは「その端末を制御端末にしているセッション」で決まるので、後で出てくるsetsid()とTIOCSCTTYはこのために必要です。行の先頭でCtrl+Dを押すと、シェルのread()が0バイトで返って、シェルはEOFと見なして終了します。1

psで見てみる

この関係は、termletを動かしたまま外からpsや/procで確かめられます。termletの中のbashでsleep 300 | catを実行している状態で見てみます。

$ pstree -p -T $(pgrep termlet)
termlet(1001746)---bash(1001758)-+-cat(1001766)
                                 `-sleep(1001765)

termletがbashを起動し、bashがsleepとcatを起動しています。プロセスの親子関係はこれだけです。PTYとの関係はpsで見えます。

$ ps -o pid,ppid,pgid,sid,tty,tpgid,stat,comm -p 1001746,1001758,1001765,1001766
    PID    PPID    PGID     SID TT         TPGID STAT COMMAND
1001746 1001704 1001704 1001704 ?             -1 SNl  termlet
1001758 1001746 1001758 1001758 pts/31   1001765 SNs  bash
1001765 1001758 1001765 1001758 pts/31   1001765 SN+  sleep
1001766 1001758 1001765 1001758 pts/31   1001765 SN+  cat
  • bashは自分のPIDと同じSIDを持つセッションリーダーで(STATのs)、pts/31を制御端末にしています。これが後で出てくるsetsid()とTIOCSCTTYの結果です
  • termletのTTはpts/31ではありません。termletはマスター側を持っているだけで、pts/31はtermletの制御端末ではないからです。ここで?になっているのは、端末からではなく直接起動したためで、別の端末から起動するとその端末が表示されます
  • sleepとcatは同じプロセスグループ(PGID)で、それがpts/31のフォアグラウンドのプロセスグループ(TPGID)になっています。STATの+もフォアグラウンドという意味です。ここでCtrl+Cを押すと、line disciplineはSIGINTをこのプロセスグループ、つまりsleepとcatに送ります。bashには届きません

(STATのNは、この環境で優先度が下がっていたためで、termletとは関係ありません。)

マスターとスレーブは、/procのファイルディスクリプタを見ると分かります。

$ ls -l /proc/1001746/fd | grep ptmx
lrwx------. 1 masahiko masahiko 64 Nov 11 15:10 13 -> /dev/ptmx
lrwx------. 1 masahiko masahiko 64 Nov 11 15:10 14 -> /dev/ptmx
$ grep tty-index /proc/1001746/fdinfo/13
tty-index:	31
$ ls -l /proc/1001758/fd
lrwx------. 1 masahiko masahiko 64 Nov 11 15:10 0 -> /dev/pts/31
lrwx------. 1 masahiko masahiko 64 Nov 11 15:10 1 -> /dev/pts/31
lrwx------. 1 masahiko masahiko 64 Nov 11 15:10 2 -> /dev/pts/31

termletが持っているのは/dev/ptmx、つまりマスター側です。2つあるのは、PTYを読むスレッド用に複製しているからです。マスターはどれも/dev/ptmxと表示されるので、どのスレーブと対になっているかはfdinfoのtty-indexで分かります。ここでは31、つまり/dev/pts/31です。bashの標準入出力は、その/dev/pts/31につながっています。

termletの構成

依存しているクレートはこれだけです。

クレート 役割
winit ウィンドウとイベントループ
glutin / glow OpenGLのコンテキストと描画
rustix PTY、termios、setsidなどのシステムコール
alacritty_terminal エスケープシーケンスの解釈と画面のグリッド
crossfont フォントのラスタライズ

データの流れはこうなっています。

キー入力 ──> keys::encode ──> PTY ──> シェル / Emacs
                                         │
画面 <── 描画 <── Term <── Processor::advance <──┘

シェルが出力したバイト列をalacritty_terminalのProcessor::advanceに渡すと、Termの中のグリッドが更新されます。描画は毎フレームTermからセルを読み出して描くだけで、描画側は画面の内容を持ちません。

エスケープシーケンスのパーサを自分で書くと、それだけでおそらく数千行になります。alacritty_terminalが使っているvteクレート(0.15.0)だけで4,144行あります。ここを書かなくていいのが一番大きいです。

空の画面を出す

まずはウィンドウを開いて単色で塗るだけです。地味ですが、ここが一番未知数が多いところでもあります。コンポジタやGPUドライバ、クレートのバージョンの組み合わせで動かないなら、PTYやエスケープシーケンスの話に入る前に分かったほうが安く済みます。

winitでイベントループを回し、glutinでOpenGLのコンテキストを作って、glowで塗ります。

impl ApplicationHandler for App {
    fn resumed(&mut self, el: &ActiveEventLoop) {
        // ウィンドウ、GLコンテキスト、サーフェスはここで作る
    }

    fn window_event(&mut self, el: &ActiveEventLoop, _: WindowId, ev: WindowEvent) {
        match ev {
            WindowEvent::RedrawRequested => {
                unsafe {
                    gl.clear_color(0.08, 0.09, 0.11, 1.0);
                    gl.clear(glow::COLOR_BUFFER_BIT);
                }
                surface.swap_buffers(context).unwrap();
            }
            WindowEvent::Resized(size) => {
                if let (Some(w), Some(h)) =
                    (NonZeroU32::new(size.width), NonZeroU32::new(size.height))
                {
                    surface.resize(context, w, h);
                    unsafe { gl.viewport(0, 0, w.get() as i32, h.get() as i32) }
                }
            }
            WindowEvent::CloseRequested => el.exit(),
            _ => {}
        }
    }
}

PTYを開いてシェルを起動する

全体像で見たPTYを、実際に開いてシェルを起動します。

let master = rustix::pty::openpt(OpenptFlags::RDWR | OpenptFlags::NOCTTY)?;
rustix::pty::grantpt(&master)?;
rustix::pty::unlockpt(&master)?;
let name = rustix::pty::ptsname(&master, Vec::new())?;
let slave = rustix::fs::open(&name, OFlags::RDWR, Mode::empty())?;

let mut cmd = Command::new(shell);
cmd.env("TERM", "xterm-256color");
cmd.env("COLORTERM", "truecolor");
let sfd = slave.try_clone()?;
unsafe {
    cmd.pre_exec(move || {
        rustix::process::setsid()?;
        rustix::process::ioctl_tiocsctty(&sfd)?;
        rustix::stdio::dup2_stdin(&sfd)?;
        rustix::stdio::dup2_stdout(&sfd)?;
        rustix::stdio::dup2_stderr(&sfd)?;
        Ok(())
    });
}

子プロセス側では、setsid()で新しいセッションを作ってから、TIOCSCTTYでスレーブを制御端末にします。TIOCSCTTYは「制御端末を持っていないセッションリーダー」からしか呼べないので、この順番は入れ替えられません。

厄介なのは、TIOCSCTTYを書き忘れても、シェルがbashだと普通に動いてしまうことです。bashは起動時に自分で制御端末を取り直すので、間違いに気づけません。なのでtermletでは、起動後にtcgetpgrp()でマスター側のフォアグラウンドプロセスグループを確認して、子プロセスが本当に制御端末を取れたかをチェックしています。

PTYの大きさは、spawn()の前にTIOCSWINSZで設定しておきます。シェルは起動時に端末の大きさを読むからです。

COLORTERM=truecolorも必要です。xterm-256colorのterminfoは24bit色の能力を持っていないので、これがないとEmacsなどは色を256色に丸めてしまいます。

画面を描く

PTYの読み込みは別スレッドで行っています。読んだバイト列はチャネルでメインスレッドに送り、EventLoopProxy::send_eventでイベントループを起こします。メインスレッドはそれをProcessor::advanceでTermに流し込んで、再描画を要求します。

描画はかなり素朴です。term.renderable_content()が返すセルを1つずつ見て、背景色の四角形と文字のテクスチャを描いているだけです。

for cell in content.display_iter {
    let line = cell.point.line.0 + offset as i32;
    let col = cell.point.column.0;
    let (x, y) = (col as i32 * cw, line * ch);
    let c = cell.cell;
    let (mut fg, mut bg) = resolve(c.fg, c.bg, c.flags, &self.palette, colors);
    if cursor.is_some_and(|p| p.line == line as usize && p.column.0 == col) {
        fg = bg;
        bg = named(NamedColor::Cursor);
    }
    if bg != default_bg {
        let w = cw * (1 + c.flags.contains(Flags::WIDE_CHAR) as i32);
        r.fill(x, y, w, ch, bg);
    }
    if !c.flags.contains(Flags::WIDE_CHAR_SPACER) {
        glyphs.push((c.c, c.flags.contains(Flags::BOLD), x, y, fg));
    }
}
r.begin_glyphs();
for (c, bold, x, y, fg) in glyphs {
    r.glyph(c, bold, x, y, fg);
}

スクロールバックは、ほぼalacritty_terminalがやってくれます。ホイールが回ったらterm.scroll_display()を呼ぶだけです。renderable_content()はスクロールした位置のセルを返してくれるので、描画側は何も変えなくていいです。

キー入力をバイト列にする

キーボードから届いたキーは、アプリが期待するバイト列に変換してPTYに書き込みます。ほとんどは見たままですが、知っていないとハマるものがいくつかあります。

  • Enterは\nではなく\r
  • Backspaceは0x7f
  • Ctrlと英字の組み合わせは、文字コードと0x1fの論理積です(C-cは0x03)
  • Altは前にESCを付けます(M-xはESC x)

矢印キーには2通りの送り方があります。普段はCSI A(\e[A)ですが、アプリがDECCKMというモードを有効にすると、SS3 A(\eOA)を送らないといけません。vimやEmacsはこのモードを使うらしいので、これを見ていないと矢印キーが効かなくなります。モードの状態はTermが持っているので、term.mode()を見て切り替えるだけです。

fn cursor_key(c: u8, mods: ModifiersState, app: bool) -> Vec<u8> {
    let m = modifier_param(mods);  // 1 + Shift + Alt*2 + Ctrl*4
    if m > 1 {
        format!("\x1b[1;{m}{}", c as char).into_bytes()  // C-→ は \e[1;5C
    } else if app {
        vec![0x1b, b'O', c]
    } else {
        vec![0x1b, b'[', c]
    }
}

修飾キー付きの矢印(C-→など)は、モードに関係なくCSI 1;<修飾> Xの形で送ります。

Emacsを動かす

ここまでで、シェルやvimは動きます。ですがEmacsを動かそうとすると、もうひと手間かかります。アプリからの問い合わせに答える必要もあるからです。

たとえばEmacsは起動時に、DA2(Secondary Device Attributes)という問い合わせを送って端末の種類とバージョンを尋ね、その答えを見て使う機能を決めます。Emacs 30.2のxterm.elでは、バージョンが216以上ならmodifyOtherKeysを有効にし、242以上なら背景色を問い合わせます。答えが返ってこないと、タイムアウト(既定で2秒)を待ったうえで、どちらも使わずに動きます。

ありがたいことに、TermはDA1/DA2やカーソル位置の問い合わせ(DSR)にすでに答えてくれます。DA2には\e[>0;2600;1cと答えます。2600はalacritty_terminalのバージョン0.26.0から作った値で、216も242も超えています。答えはEvent::PtyWriteというイベントとしてEventListenerに渡されるので、それをPTYに書き戻すだけです。

impl EventListener for ToPty {
    fn send_event(&self, ev: Event) {
        let bytes = match ev {
            Event::PtyWrite(s) => s.into_bytes(),
            Event::ColorRequest(i, f) => f(self.palette.index(i)).into_bytes(),
            Event::TextAreaSizeRequest(f) => f(self.size.get()).into_bytes(),
            _ => return,
        };
        let _ = self.tx.send(bytes);
    }
}

背景色の問い合わせ(OSC 11)とウィンドウの大きさの問い合わせ(CSI 14t)だけはPtyWriteではなく、それぞれColorRequestとTextAreaSizeRequestとして届きます。値を渡すと応答の文字列を作ってくれる関数が付いてくるので、パレットの色やウィンドウの大きさを渡します。ToPtyは応答をチャネルに送るだけで、PTYへの書き込みは、出力をTermに流し込んだあとにメインスレッドでまとめてやっています。OSC 11に答えると、Emacsは背景が暗いことを知って、暗い背景向けの色を選んでくれます。

modifyOtherKeys

EmacsでC-;やC-,を使うには、modifyOtherKeysという仕組みが要ります。C-;には対応する制御文字がないので、普通の端末では;がそのまま送られてしまいます。EmacsはDA2の答えを見たあと\e[>4;1mを送って端末にmodifyOtherKeysを有効にするよう頼み、有効になるとC-;は\e[27;5;59~という形で届くようになります。

ところがTermはmodifyOtherKeysを実装していません。Handlerの71個のメソッドのうち、Termが実装しているのは66個で、modifyOtherKeysの2つ(set_modify_other_keysとreport_modify_other_keys)はその外です。そこでtermletでは、Processor::advanceに渡す前のバイト列を覗いて\e[>4;Nmを拾い、状態を自分で持つようにしました。バイト列はPTYから読んだ単位で区切られて届き、シーケンスが途中で切れていることもあるので、小さな状態機械にしています。CSIのパラメータを集め終わったら、こう判定します。

fn finish(&mut self, reply: &mut Vec<u8>) {
    match self.buf.as_slice() {
        b">4" | b">4;0" => self.mode = 0,
        b">4;1" => self.mode = 1,
        b">4;2" => self.mode = 2,
        b"?4" => reply.extend_from_slice(format!("\x1b[>4;{}m", self.mode).as_bytes()),
        _ => {}
    }
}

CSI ? 4 mは今のモードを尋ねる問い合わせなので、これにも答えます。キー入力の側では、モードが1のときは制御文字を持たないキー(C-;など)だけを、モードが2のときはCtrlかAltの付いた文字キーすべてを、CSI 27 ; 修飾 ; 文字コード ~の形で送ります。

制限

  • Linux専用です。WaylandとX11向けのwinitの機能を使っているので、macOSやWindowsではビルドできません
  • マウスはホイールでのスクロールバックだけです。選択もコピーもできません
  • クリップボードからの貼り付けもできません
  • IMEに対応していないので、日本語は入力できません(表示はできます)
  • 描画は最適化していません。グリフのアトラスも差分描画もありません
  • 設定ファイルはありません。フォント(JetBrains Mono、15px)も色も決め打ちです
  • タブも画面分割もありません

おわりに

ソースはGitHubに置いてあります。MITライセンスです。

  1. 普段のbashはreadlineを使っていて、プロンプトで待っている間はICANONとECHOを切っています。この場合は行をためるのもエコーもbash自身がやっていて、line disciplineは入力を1バイトずつそのままbashに渡します。Ctrl+Cの処理(ISIG)と出力の改行変換(ONLCR)は有効なままです。ただ、端末エミュレータからはこの違いは見えません。どちらの場合も、termletはキーをバイト列にしてマスターに書き、マスターから返ってきたバイト列を画面に描くだけです。誰がエコーしているかを知る必要はありません。 ↩