More than 1 year has passed since last update.

君はkiloを知っているか

Last updated at 2022-12-09Posted at 2022-12-07

Advent calendar初参加でした(// //) 期日少し遅れてごめんなさい💦

kiloとは

kiloとは1000行前後のC言語ファイル1つで構築されるテキストエディターである。
それを作成してみるハンズオン(「Build Your Own Text Editor」)が公開されており、今回それをしてみたので、報告する。

きっかけ

Vimがどのように文字列を表示しているのかが不思議であったので、いつか調べたいと思いつつ、C言語をしっかりと使ったことはないし、ソースを読んでもなんとなく以上のことはわからなかった。
(特に、どこで画面上の文字(の位置)が制御されているのか全然分からなかった！)

そんな中、C言語でエディタを作るというチュートリアルが公開されていたことに気付いたので、練習として取り組んでみることにした。

チュートリアルの章立て

Setup(セットアップ)
Entering raw mode(画面をクリアして入力キーを受け取る)
Raw input and output(初期画面を表示したりカーソルを動かしたり)
A text viewer(ファイルを読み込んで表示したりステータスバーを作ったり)
A text editor(編集・保存できるようにする)
Search(検索)
Syntax highlighting(シンタックスハイライト)
Appendices(補足)

なお、第2章が終わった段階では、こんな感じ。

kilo.c

/*** includes ***/

#include <ctype.h>
#include <errno.h>
#include <stdio.h>
#include <stdlib.h>
#include <termios.h>
#include <unistd.h>

/*** data ***/

struct termios orig_termios;

/*** terminal ***/

void die(const char *s) {
  perror(s);
  exit(1);
}

void disableRawMode() {
  if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &orig_termios) == -1)
    die("tcsetattr");
}

void enableRawMode() {
  if (tcgetattr(STDIN_FILENO, &orig_termios) == -1) die("tcgetattr");
  atexit(disableRawMode);

  struct termios raw = orig_termios;
  raw.c_iflag &= ~(BRKINT | ICRNL | INPCK | ISTRIP | IXON);
  raw.c_oflag &= ~(OPOST);
  raw.c_cflag |= (CS8);
  raw.c_lflag &= ~(ECHO | ICANON | IEXTEN | ISIG);
  raw.c_cc[VMIN] = 0;
  raw.c_cc[VTIME] = 1;

  if (tcsetattr(STDIN_FILENO, TCSAFLUSH, &raw) == -1) die("tcsetattr");
}

/*** init ***/

int main() {
  enableRawMode();

  while (1) {
    char c = '\0';
    if (read(STDIN_FILENO, &c, 1) == -1 && errno != EAGAIN) die("read");
    if (iscntrl(c)) {
      printf("%d\r\n", c);
    } else {
      printf("%d ('%c')\r\n", c, c);
    }
    if (c == 'q') break;
  }

  return 0;
}

少しずつ説明を加えながら進んでいくので、分かりやすい。

長い感想

先に感想を書いてしまう。

分かりやすい

分かりやすかった。とても。

コンパイラのオプション大事

第1章で、Makefileの作成を進められるとともにオプションの指定もされる。

Makefile

kilo: kilo.c
	$(CC) kilo.c -o kilo -Wall -Wextra -pedantic -std=c99

C言語を普段扱う人には普通なのかもしれないが、この厳密なWARNINGを出してくれる設定のおかげで、
写経のミスに気づきやすかったし、何度も何度も助けられた。

エディタ画面の初期化は`<termios.h>`が使われる

長年の謎が解けた。

エスケープシーケンスなるものとVT100の存在

エスケープシーケンスは色をつけるときに知ってはいたが、他にも色々なコマンドがあることは知らなかった。
VT100というものもはじめて知った。今でも痕跡が残っているなんてすごいぞ。(Wikipedia VT100)

画面上の特定の位置に表示する仕組み

Vimではそうでなかった気がするが、今回作成したものは毎回全表示文字列を表示していると分かった。
エスケープシーケンスを使っても可能そうではある。

ソースコードが読みやすくなる

大体最後にまとめてredrawするんだな、とかデータ構造はこんなのがあるはずだな、とか、
シンタックスハイライトはここでやっているのか、とか、
そういう見通しが立てやすくなったのでかなり読みやすくなった。

Vimのソースを読んでみる

?「Vimはモーダルエディタだからkiloとは違うじゃんよ」
僕「そーっすね」

`write`

バッファからのフラッシュの際、結局はmch-writeでwriteが呼ばれているようだ。
github
普通にSTDOUTを使うんだなあという感動。

src/os_unix.c

/*
 * Write s[len] to the screen (stdout).
 */
    void
mch_write(char_u *s, int len)
{
    vim_ignored = (int)write(1, (char *)s, len);
    if (p_wd)		// Unix is too fast, slow down a bit more
	RealWaitForChar(read_cmd_fd, p_wd, NULL, NULL);
}

なお、バッファーはout_bufという名前で、out_flush -> ui_write -> mch_write -> write という形。
もうちょっというと、main_loopの割と最後の方でupdate_screenが呼ばれ、その後win_update->win_line->screen_char->out_char->out_flush-> and so on といった感じ（多分）
(なお、vim.hの427行目あたりに、# include <stdio.h>はちゃんと存在している。)

`tcsetattr`

main関数はsrc/main.cの92行目あたりに存在している。(link)
ターミナルをRaw Modeにするときに、tcgetattrおよびtcsetattr(termios.h)が使われる。
元のRaw Modeの設定が行われている場所は、src/main.cのvim_main2内で見つけられる。(link)

src/main.c

    /*
     * When done something that is not allowed or given an error message call
     * wait_return().  This must be done before starttermcap(), because it may
     * switch to another screen. It must be done after settmode(TMODE_RAW),
     * because we want to react on a single key stroke.
     * Call settmode and starttermcap here, so the T_KS and T_TI may be
     * defined by termcapinit and redefined in .exrc.
     */
    settmode(TMODE_RAW);
    TIME_MSG("setting raw mode");

main -> vim_main2 -> settmode -> mch_settmode(term.c) -> tcsetattr (os_unix.c)

(なお、term.cやos_unixx.hで、# include <termios.h>を見つけることができる。)

カーソルの位置

kiloでは、下記のような感じになっている。(cx, cyがそれ)

struct editorConfig {
  int cx, cy;
  int rx;
  ...
};

kiloでは1つのファイルの編集の話になっているのに対して、Vimでは複数のバッファーを持ちうるし、コマンドの実行やヴィジュアルモードなど、やや複雑なので、ここもエディター付属ではなく、多数の構造体に付属する感じになっている。
カーソルの位置を表すもの自体は、下記のようになっている。

src/structs.h

/*
 * Position in file or buffer.
 */
typedef struct
{
    linenr_T	lnum;	// line number
    colnr_T	col;	// column number
    colnr_T	coladd; // extra virtual column
} pos_T;

なお、

src/vim.h

typedef long	linenr_T;		// line number type
typedef int	colnr_T;		// column number type
typedef unsigned short disptick_T;	// display tick type

(link: src/structs.h src/vim.h)

最後に

楽しかった。とても。

(おまけ)最終的なファイル

Qiitaで眺められると嬉しいという理由で、ここに完成したスクリプトを一応載せます。