ANSIエスケープコード

ANSIエスケープコードとは

詳細な一覧は Wikipedia に英語ではあるが載っている。 できることは大まかにいうと、 コンソール上のカーソル位置の移動、出力済みテキストの消去、コンソールのスクロール、 テキストフォントの種別指定、前景色、背景色の指定、といったところになる。

いわゆる端末エミュレータと呼ばれるコンソールでこのシーケンスが解釈され、 テキスト端末であるコンソールでグラフィカルな表現を行うことができる。 ただし、対応しているかどうか、対応しているとしてもどこまで対応しているかは端末次第で、 Windowsのコマンドプロンプトでは（そのままでは）利用できない。

UNIX系の環境なら標準のターミナルエミュレータを使えばよいが、Windows環境だと Cygwin + TeraTerm + Cygterm などが手軽かもしれない。

このANSIエスケープコード （更に正確には、その中のCSI (Control Sequence Introducer (Indicator))コードと呼ばれるもの） のフォーマットは以下のようになっている。

ESC[n1;n2;...X

最初のESCは表示文字でないので便宜上このように表示しているが、エスケープコード（文字コード：0x1b）である。 次が[（左角括弧）、続いて、引数が;（セミコロン）で区切られて続き、 最後にシーケンス識別文字が来る。

前回紹介したエスケープシーケンスと異なり、 ここでのエスケープの始まりは\ではなく、エスケープコードから始まる。 エスケープコードの文字コードは0x1bなので、これを\を使ったエスケープシーケンスで表現すると、 8進数で\033、もしくは16進数で\x1bとなる。 どちらも同じものを表現しているが、8進数を利用した\033で書かれる場合が多いようだ。

カーソル移動、及び画面制御関係のコードの一覧を次に示す。 実際にはこれ以外にもあるが、詳しくはWikipediaなどを参照のこと。

次に、これらの動作を確認するためのサンプルコードを示す。 これらは動的な制御でもあり、サンプルコードの実行結果を示すのは難しいので、 いろいろと実際に試してみて欲しい。

コードを書く上での注意点だが、 通常のprintfでは、改行コードが出力されるまではバッファリングされて、 実際にコンソールに出てこない場合がある。 最終的な出力が一致すれば良いということであれば特に気にする必要もないが、 多くの場合、動的な変化を見せたい場合に利用すると思うので、 このサンプルのようにstderrへ出力するか、 setbufを使って、出力バッファを無効にする、 またはfflushを使って、適切なタイミングでバッファを掃き出させる、などする必要がある。 この辺の解説はこちらを参照のこと。

fprintf(stderr,"1234567890");
sleep(1);
fprintf(stderr, "\033[5G");
sleep(1);
fprintf(stderr, "\033[K");

SGR(Select Graphic Rendition)コマンド

前の表で後述と書いた、グラフィック要素指定の部分を説明する。 フォーマットとしては、「ESC[nm」であり、nには整数が入る。 また、nの値によっては別の引数を取るものも存在する。 非常にバリエーション豊富なのだが、 それゆえに端末によってどこまで対応されているかもまちまちだったりする。

逐一説明してもいいのだが、 まずは以下のように、nの値を順に変化させながら出力するサンプルコードを実行してみる。 後に説明するが、「ESC[0m」は、それまでの指定を無効化してもとに戻すという意味がある。

for (i = 0; i < 11; i++) {
  for (j = 0; j < 10; j++) {
    const int v = i*10+j;
    printf("\033[%dm%03d\033[0m ", v, v);
  }
  printf("\n");
}

実行結果だが、テキストのアウトプットを書いても仕方ないので、 実際のコンソールのスクリーンショットを掲載する。

以下が、Ubuntuのgnome-terminal（日本語環境だと「端末」となっているもの）での実行結果。

以下が、Ubuntuのxtermでの実行結果。 このスクリーンショットでは005が表示されていないが、点滅表示されている。

以下が、Windows上のTeraTermでの実行結果

いずれも実行している実行ファイルは同一で、出力されるコードも同一である。 違いが出ているのは各端末で出力されたコードの解釈のされ方や表示のされ方の違いによるものだ。 結果的にみると、指定して意味がありそうな値の範囲は「0-9」「30-49」「90-109」の間ぐらいのようだ。 次にこの範囲の指定についてまとめる。

色の指定であるが、0～7の色指定が使える、これはANSIカラーとも呼ばれるもので概ね以下の様な定義になる。 実際にはいわゆる純色ではなく、輝度をグレーに寄せたり、彩度を少し落としたような色が使われる。

これらの色は、端末エミュレータの設定などで変更できる場合も多い。

このSGR指定は;でつなげることもできる、 例えば、\033[1;30;47mと指定すると、ボールド、文字色黒、背景白、となる

UNIX系のコマンドだと、lsなどを使った時に、 ファイルの属性などによって異なる色でテキストが表示されることがあると思うが、 あの色は、これと同様の仕組みで指定されている。

色指定の8は拡張用に用意されており、 追加の引数で詳細な色指定ができるようになっている。 文字の色の場合、「ESC[38;5;xm」と指定することで、 256色のカラーパレットから色を指定することができる。 その動作を確認するため、以下のサンプルコードを実行してみる。

for (i = 0; i < 16; i++) {
  for (j = 0; j < 16; j++) {
    const int v = i*16+j;
    printf("\033[38;5;%dm%02X\033[0m ", v, v);
  }
  printf("\n");
}

以下が、Ubuntuのgnome-terminalでの実行結果である。

サンプルコードの出力を「ESC[48;5;xm」に変更すると、背景色が同様に変化する。

ここまで色が使えると、単にテキストへの付加情報として色を付ける以外の使い方もできそうに思うが、 拡張用ということで、256色への対応ができる端末エミュレータは限られてくる。 とはいえ、前述のxtermやTeraTermも対応している。