連携処理３（端末制御）

端末画面上の任意の位置にカーソルを移動したり， 表示する文字の色を変更したりするには， エスケープシーケンス（escape sequence） と呼ばれる特殊な文字列を利用する．

たとえば，次のようなコマンドを実行すると， 文字の色を変更できる：

$ echo  "^[[31m Red"		# 「^[」の入力方法は下記の通り
Red
$ echo  "^[[0m Reset"
Reset
$

なお，文字列の先頭の記号 '^[' は， [Esc] キーを表わす特殊な文字である． 2 文字の文字列 "^[" ではない． この文字をコマンドラインで入力するためには， 次のように操作する：

$ PS1="$ "

これら Esc 文字から始まる文字列 （ "^[[31m" や "^[[0m"） がエスケープシーケンスである． 代表的なエスケープシーケンスの例を次の表に示しておく． なお，この表では，エスケープ文字を「Esc」と表記している．

これらのエスケープシーケンスは，端末自身がもっている機能であるため， プログラミングの際には，何ら特別な工夫を必要とせずに利用できる． 単純に，printf( ) 関数などによって， エスケープシーケンスを端末側へ出力すれば済む．

ここでは，Ｃ言語の printf( ) 関数ではなく， 同等な機能をもつ unix コマンドの printf で， お手軽に試してみよう：

$ printf  "クリアして \e[2J"
$ printf  "\e[3;0H ３行目で \e[31m 赤にしたり\n"
$ printf  "\e[1;10H １行目へ戻ってみたり\n"
$ printf  "\e[5;0H\e[0m ５行目で元通りに\n"
...

ここで '\e' は Esc を表わす特殊文字である． 改行記号 '\n' などと同様，２文字で１文字を表わす．

エスケープシーケンスの文字列は， 人間が読んでもほとんど意味不明な「呪文（curse）」のようなものであり， それを直接利用してプログラムを作成するなんてことは非常に面倒だ． そこで，この面倒な処理を簡単化するための関数群が curses ライブラリとして用意されている．

このライブラリの関数を利用すると， 端末画面上の任意の位置にカーソルを移動したり， 表示する文字の色を変更したりするプログラム （いわゆるフルスクリーンアプリケーション） が簡単に実現可能になる．

単純な curses プログラム hello.c を作ってみよう：

#include <ncurses.h>

int main(void)
{
	initscr();	// 端末制御の開始

	start_color();	// カラーの設定
	init_pair(1, COLOR_RED, COLOR_BLUE);	// 色番号１を赤文字／青地とする
	bkgd(COLOR_PAIR(1));			// 色１をデフォルト色とする

	erase();	// 画面表示
	move(10, 20);
	addstr("Hello World");
	refresh();

	timeout(-1);
	getch();	// キー入力

	endwin();	// 端末制御の終了
	return (0);
}

これをコンパイルするには，-lncurses オプションを指定し， ライブラリをリンクする必要がある：

$ cc  hello.c  -lncurses  -o hello

実行すると，メッセージが表示され，何かキーを押すと終了する．

ソースを読んでみよう． これまでのプログラムとは全然違うものに見えるだろう． とりあえず今は，細かいことについては，気にしないでよい．

まず，おなじみのヘッダファイル stdio.h とか 標準ライブラリの入出力関数 printf( ) や scanf( ) とかは， まったく使われていない． その代わり，ncurses.h をインクルードし， curses ライブラリの関数だけを使っている．

curses の関数についての詳しくは， 参考資料を参照せよ．

次のセクションから， curses ライブラリの使い方を段階的に学習して行く． ある程度まで理解できたら，自由に改造してみよう．

基本プログラムとして，端末画面に文字列を表示してみよう． 何らかのキーを押すと終了する．

hello-1.c：

#include <ncurses.h>

int main(void)
{
	initscr();

	move(10, 20);
	addstr("Hello World");
	getch();

	endwin();
	return (0);
}

これは，端末画面の上から 10 行目，左から 20 桁目の位置に 文字列 "Hello World" を表示するだけのものであり， 何かキーを押すと終了する．

ここで利用されている関数の意味は次の通り：

• initscr()：端末制御の開始
• move(行, 桁)：カーソルの移動
• addstr(文字列)：文字列の表示
• getch()：キー入力
• endwin()：端末制御の終了

なお，画面表示の関数としては， addstr() の他に，次のようなものもある：

• addch(文字)：1 文字の表示
• printw(書式, データ, データ, ...)：curses 版の printf( )

• mvaddch(行, 桁, 文字)：move( ) + addch( )
• mvaddstr(行, 桁, 文字列)：move( ) + addstr( )
• mvprintw(行, 桁, 書式, データ, ...)：move( ) + printw( )

文字列表示をセンタリング（centering；中央揃え）してみよう．

hello-2.c：

#include <ncurses.h>
#include <string.h>

int main(void)
{
	int	x, y, w, h;
	char	*str = "Hello World";

	initscr();
	getmaxyx(stdscr, h, w);
	y = h/2;
	x = (w - strlen(str))/2;

	move(y, x);
	addstr(str);
	getch();

	endwin();
	return (0);
}

まず，一度，実行してみよう． そして，端末ウィンドウのサイズを変更してから， 再度，実行してみよう． サイズに応じて，表示位置が自動的に調整されるハズだ．

次の関数が登場した：

• getmaxyx(stdscr, 変数1, 変数2)： 変数1 に画面の高さ（行数）， 変数2 に画面の幅（桁数）を代入

ここで，stdscr は端末画面を表わす定数である． 標準出力 stdout の curses 版だと考えればよい．

ところで，Ｃの基本がわかっている人は疑問に思うハズだ． なぜ，利用方法が getmaxyx(stdscr, &h, &w) ではなく， getmaxyx(stdscr, h, w) なのか？

それは，getmaxyx( ) が実は，関数ではなくマクロであるからだ． 次のような感じに引数付きマクロとして定義されている：

#define getmaxyx(画面, y, x) { y=画面の行数; x=画面の桁数; }

次に，何かキーを押すたびに表示位置を変化するようにしてみよう． [Q]キーを押すと終了する．

hello-3.c：

#include <ncurses.h>
#include <string.h>

int main(void)
{
	int	x, y, w, h;
	char	*str="Hello World";
	int	key;

	initscr();
//	noecho();		// echo();
//	cbreak();		// nocbreak();
	getmaxyx(stdscr, h, w);
	y = h/2;
	x = (w - strlen(str))/2;

	while (1) {
//		erase();
		move(y, x);
		addstr(str);
//		refresh();

		key = getch();
		if (key == 'q') break;

		y++; if (y >= h) y = 0;
	}
	endwin();
	return (0);
}

無効化（コメント化）されている部分（// 以降）を 有効化しないと（// を外さないと）うまく行かないだろう． まず，コメントのまま実行し，その後，有効化して実行し， 動作を比較してみよう．

次の関数が出てきた：

• noecho()：キー入力した文字の非表示モード
• cbreak()：[Enter]キー不要の入力モード
• erase()：画面の消去
• refresh()：画面の再表示

ここで，refresh() の意味がよくわからないかもしれない． curses では， 実際の表示用の画面（物理画面，実画面）の他に， 内部的な作業用の画面（論理画面，裏画面）を利用している． 通常，出力の処理は，論理画面にバッファリングされる． つまり，出力しただけでは，実際の画面上に即座に表示されるとは限らない．

確実に表示したい場合には， 出力処理の後で refresh() が必要となっている． これで，論理画面の内容が物理画面へ確実にコピーされ， 実際に見えるようになるハズだ．

今度は，キー入力しなくても自動的に動くようにしてみよう． hello-3.c のコピーを作り，次のように変更しよう． （また後で使うので，hello-3.c は書き換えずに残しておこう．）

hello-4.c：

...
#include <unistd.h>		// usleep()

int main(void)
{
	...
	initscr();
	noecho();
	cbreak();
	timeout(0);
	...

	while (1) {
		...
		usleep(100000);
	}
	endwin();
	return (0);
}

次の関数を追加しただけ：

• timeout(0)：キー入力を待たないモード
• usleep(μ秒)：指定時間だけ処理停止 （こいつは curses 関数ではない． #include <unistd.h>）

前のコードでは，下方向にしか移動できなかった． 今度は，カーソルキーの入力によって上下左右に移動できるようにする． hello-3 を元にして，次のように書き換えよう．

hello-5.c：

...

int main(void)
{
	...
	initscr();
	noecho();
	cbreak();
	keypad(stdscr, TRUE);
	...
	while (1) {
		...
		key = getch();
		if (key == 'q') break;
		switch (key) {
		case KEY_UP:	y--; break;
		case KEY_DOWN:	y++; break;
		case KEY_LEFT:	x--; break;
		case KEY_RIGHT:	x++; break;
		}
	}
	endwin();
	return (0);
}

新たな関数はひとつだけ：

• keypad(stdscr, TRUE)：特殊キー（カーソルキーなど）を有効化

さてここで， getch( ) の戻り値の型が char ではなく int だったことの理由を明かそう． ASCII コード（１バイトの数値，0x00 〜 0xFF） だけでは表わしきれない程に多数ある特殊キーにも 番号（４バイトの数値，0x00000100 〜 0xFFFFFFFF）が割り当てられている． また，各特殊キーには， わかり易いマクロ名も定義されている：

• KEY_UP：[↑] キー
• KEY_DOWN：[↓] キー
• KEY_LEFT：[←] キー
• KEY_RIGHT：[→] キー
• ...

今度は，カラーを使ってみる． ソースファイルをゼロから作成しよう．

color.c：

#include <ncurses.h>

int main(void)
{
	// 端末の準備
	initscr();

	// 色の準備
	start_color();
	init_pair(1, COLOR_RED, COLOR_BLUE);	// 色1 は青地に赤文字
	init_pair(2, COLOR_GREEN, COLOR_BLUE);	// 色2 は青地に緑文字
	init_pair(3, COLOR_YELLOW, COLOR_BLUE);	// 色3 は青地に黄文字
	init_pair(10, COLOR_WHITE, COLOR_BLUE);	// 色10 は青地に白文字
	bkgd(COLOR_PAIR(10));			// 背景は色10

	// 表示
	attrset(COLOR_PAIR(1));			// 色1 を使う
	mvaddstr(5,  5, "Hello World");
	attrset(COLOR_PAIR(2));			// 色2 を使う
	mvaddstr(5, 25, "Hello World");
	attrset(COLOR_PAIR(3));			// 色3 を使う
	mvaddstr(5, 45, "Hello World");

	attrset(COLOR_PAIR(1) | A_BOLD);		// 色＆強調表示
	mvaddstr(6,  5, "Hello World");
	attrset(COLOR_PAIR(2) | A_BOLD);
	mvaddstr(6, 25, "Hello World");
	attrset(COLOR_PAIR(3) | A_BOLD);
	mvaddstr(6, 45, "Hello World");

	attrset(COLOR_PAIR(1) | A_REVERSE);		// 色＆反転表示
	mvaddstr(7,  5, "Hello World");
	attrset(COLOR_PAIR(2) | A_REVERSE);
	mvaddstr(7, 25, "Hello World");
	attrset(COLOR_PAIR(3) | A_REVERSE);
	mvaddstr(7, 45, "Hello World");

	attrset(COLOR_PAIR(1) | A_REVERSE | A_BOLD);	// 色＆反転＆強調
	mvaddstr(8,  5, "Hello World");
	attrset(COLOR_PAIR(2) | A_REVERSE | A_BOLD);
	mvaddstr(8, 25, "Hello World");
	attrset(COLOR_PAIR(3) | A_REVERSE | A_BOLD);
	mvaddstr(8, 45, "Hello World");

	// 終了
	getch();
	endwin();
	return (0);
}

端末の種類や設定によっては，うまく働かない機能もあるかもしれないが， あまり気にしないでおこう．

全角日本語文字列（というかマルチバイト文字列）も利用できる：

#include <ncurses.h>
#include <locale.h>	// setlocale() に必要

int main(...)
{
	setlocale(LC_ALL, "");		// システム側の言語環境（日本語）を利用するよ
	initscr();
	...
	addstr("こんにちWorld");	// 全角・半角の混合文字列も使えるよ
	...
}

コンパイル方法： （ncurses ではなく，ncursesw ライブラリを使用）

$ cc  ...  -lncursesw  ...

このように，文字列全体を表示するだけなら，とても簡単だ． しかし，全角文字では，２バイト以上で１文字を表現していたり， 画面上で半角２文字分の幅を使ったりするので， 下の練習問題２のように， １文字ずつとか１バイトずつに分解して処理することは難しい．

プログラム hello-4 では， プログラムの開始と同時にアニメーションも開始してしまう． アニメーションのスタート／ストップについて， キーボード操作によって自由にコントロールできるように改良せよ．

例えば，プログラム実行直後には文字列の移動を止めておき， [Space]キーを押すたびに，文字列の移動の開始／停止を繰り返せるようにしよう．

ヒント：移動中フラグとか移動速度とかの変数を追加すればできるだろう．

プログラム hello-5 で左右に移動しているとき， 文字列の一部が画面からハミ出すと表示が乱れてしまう． この不具合への対策を施せ．

1. 画面内からハミ出さないように， 文字列の移動範囲を制限するように改良せよ．

   ヒント：画面右側の範囲チェックでは， 文字列の末尾の座標を調べる必要があるだろう．

2. （上級者用問題）ハミ出した部分文字列（文字列全体ではなく）が 画面の反対側から（右にハミ出ると左から，左にハミ出ると右から） 出てくるように改良せよ．

   ヒント：addstr( ) ではなく， addch( ) または mvaddch( ) を利用するとよい． つまり，文字列を一度に出力するのではなく， 一文字ずつ位置を指定しながら出力するとよい． このとき，当然，各文字の出力位置が画面内に収まるようにすること．

PC に内蔵されているタイマを利用し， 時計アプリを作ってみよう．

時計機能の練習として，まずは curses を使わず，時刻を標準出力してみる．

clock-0.c：

#include <stdio.h>	// まずは，curses ではなく，標準入出力ね
#include <time.h>	// time(), localtime(), strftime()

/*
現在の時刻文字列を生成する関数
buf：時刻文字列バッファ（参照渡し）
n：文字列バッファのサイズ
*/
void GetTimeStr(char *buf, int n)
{
	time_t		t;	// 現在の unix 時刻が入るよ
	struct tm	*tm;	// 時刻要素構造体へのポインタが入るよ

	t = time(NULL);		// 現在の unix 時刻を取得
	tm = localtime(&t);	// unix 時刻を時刻要素（年月日時分秒）へ分解
	strftime(buf, n, "%H:%M:%S", tm);	// 時刻文字列（時:分:秒）を生成
}

#define BUFLEN	10	// 文字列バッファの配列サイズ

int main(void)
{
	char	buf[BUFLEN];	// 時刻文字列が入るよ

	GetTimeStr(buf, BUFLEN);	// 時刻文字列を取得
	printf("%s\n", buf);		// 時刻文字列を表示

	return (0);
}

新出の関数：（#include <time.h>）

• time_t time(NULL)： 現在の unix 時刻（unix 紀元1970年01月01日00:00:00 からの経過秒数）を返す．
  なお，time_t 型は， long int 型（64 bit 整数）の別名として typedef されている． 「2038年問題」は int 型（32 bit 整数）だった昔の話ね．
• struct tm *localtime(時刻へのポインタ)： 時刻を時刻要素（年月日時分秒）へ分解し，時刻要素構造体へのポインタを返す． （時刻要素は localtime() 内に static 変数として温存．）
  static変数の場合， 関数終了時にもメモリ領域が解放されず，データが温存される．
  一方，通常の auto変数の場合，データは破棄される． （ゴミとして残る場合もあるが，保証なし．）
• strftime(文字列バッファ, バッファサイズ, 書式文字列, 時刻要素構造体へのポインタ)： 時刻文字列を生成．（書式付き文字列生成関数 snprintf() の時刻版．）

clock-0.c を元にして，フルスクリーン化してみる．

clock-1.c：

// #include <stdio.h>
#include <ncurses.h>
#include <string.h>
#include <time.h>

/*
デジタル時計を表示する関数
s：時刻文字列
*/
void DrawClock(char *s)
{
	int	x, y;		// 表示位置
	int	w, h;		// 画面サイズ

	getmaxyx(stdscr, h, w);	// 画面サイズを取得
	x = (w - strlen(s))/2;	// 中央表示のための位置を算出
	y = h/2;

	mvaddstr(y, x, s);	// 時刻を表示
}

...
void GetTimeStr(char *buf, int n)
{
	...
}

...

int main(void)
{
	char	buf[BUFLEN];
	int	key;		// 入力キー文字が入るよ

	// 端末の初期化
	initscr();
	curs_set(0);		// カーソルは表示しないよ
	noecho();
	cbreak();
	timeout(0);		// キー入力は待たないよ

	// 時計の表示
	while (1) {
		GetTimeStr(buf, BUFLEN);

		erase();
		DrawClock(buf);			// 時刻文字列を表示
		refresh();

		key = getch();
		if (key == 'q') break;		// [Q]キーで終了
	}

	// 終了
	endwin();

	return (0);
}

表示方法をお洒落 （レトロな ７セグメント表示器）にしてみる．

clock-2.c：

#include <ncurses.h>
#include <ctype.h>
#include <string.h>
#include <time.h>

#define SEG_W	4	// ７セグ１文字分の幅
#define SEG_H	5	// ７セグ１文字分の高さ

/*
コロンを描く関数
y, x：表示位置
*/
void DrawColon(int y, int x)
{
	mvaddch(y+1, x+1, '#');
	mvaddch(y+3, x+1, '#');
}

/*
７セグメントの文字を表示する関数
y, x：表示位置
seg：点灯パターン文字列（７文字＋終端記号）
*/
void Draw7SegChar(int y, int x, char *seg)
{
	if (seg[0] == '1') mvaddstr(y+0, x+0, "###");

	if (seg[1] == '1') {
		mvaddstr(y+0, x+0, "#");
		mvaddstr(y+1, x+0, "#");
		mvaddstr(y+2, x+0, "#");
	}

	if (seg[2] == '1') {
		mvaddstr(y+0, x+2, "#");
		mvaddstr(y+1, x+2, "#");
		mvaddstr(y+2, x+2, "#");
	}

	if (seg[3] == '1') mvaddstr(y+2, x+0, "###");

	if (seg[4] == '1') {
		mvaddstr(y+2, x+0, "#");
		mvaddstr(y+3, x+0, "#");
		mvaddstr(y+4, x+0, "#");
	}

	if (seg[5] == '1') {
		mvaddstr(y+2, x+2, "#");
		mvaddstr(y+3, x+2, "#");
		mvaddstr(y+4, x+2, "#");
	}

	if (seg[6] == '1') mvaddstr(y+4, x+0, "###");
}

/*
セグメントの配置：（この図から忖度（そんたく）してね↑ ↓ ）
	0 ━━
	1┃  ┃2
	3 ━━
	4┃  ┃5
	6 ━━
*/

/*
７セグメントのデジタル時計を描く関数
s：時刻文字列
*/
void Draw7SegClock(char *s)
{
	int	x, y;		// 表示位置
	int	w, h;		// 画面サイズ

	static char	*seg[] = {	// ７セグの点灯パターン文字列
		"1110111",	// 文字0（中央のセグ３だけ消灯）
		"0010010",	// 文字1（右端のセグ２と５だけ点灯）
		"1011101",	// 文字2
		"1011011",	// 文字3
		"0111010",	// 文字4
		"1101011",	// 文字5
		"1101111",	// 文字6
		"1010010",	// 文字7
		"1111111",	// 文字8
		"1111011"	// 文字9
	};

	getmaxyx(stdscr, h, w);		// 画面サイズを取得
	x = (w - strlen(s)*SEG_W)/2;	// 中央表示のための位置を算出
	y = (h - SEG_H)/2;

	while (*s != '\0') {
		if (isdigit(*s)) {
			Draw7SegChar(y, x, seg[*s - '0']);	// 数字を描く
		} else {
			DrawColon(y, x);			// コロンを描く
		}
		x += SEG_W;	// 表示位置を次の桁へ
		s++;		// フラグ文字列を次の桁へ
	}
}

...
void GetTimeStr(char *buf, int n)
{
	...
}

...

int main(void)
{
	...
	while (1) {
		...
		erase();
		Draw7SegClock(buf);		// 時刻を７セグ表示
		refresh();
		...
	}
	...
}

さらに，カラーを使えば， もっと，お洒落にできるだろう．