Curses

Curses とは仮想端末の画面を制御するために用意されたライブラリである。 一般的な出力メソッドでは仮想端末で下方向や右方向にしか文字列を出力できなかったが、Curses を使うと仮想端末の任意の場所に文字列を出力でき、さらに色なども変更できる。

大学の環境ではすぐに Curses を利用できる。

その他の環境で利用できない場合は、次のように gem でインストールする必要がある。 

% gem install curses

基本の形式

Curses は以下の形のプログラムが基本となる。 

#!/usr/koeki/bin/ruby
# -*- coding: utf-8 -*-
 
require "curses"
 
# Cursesの初期化
Curses.init_screen
 
begin
  ＜ここに処理を入れる＞
ensure
  # Cursesの終了処理
  Curses.close_screen
end

プログラムの実行時に “warning: rb_safe_level will be removed in Ruby 3.0” と表示される場合は、次のように ruby にオプション “-W0” を付けて実行するとよい。 

% ruby -W0 プログラム

メソッド

カーソルの移動

Curses.setpos(y, x)

仮想端末の画面の座標 (x, y) にカーソルを移動する。引数では y が先なので注意。

画面の行数は Curses.lines、列数は Curses.cols で分かる。

画面上の座標

文字の出力

Curses.addch(文字)

カーソルの位置に文字を出力する。

文字列の出力

Curses.addstr(文字列)

カーソルの位置に文字列を出力する。

画面表示の更新

Curses.refresh

Curses.addstr で文字列を出力をしても Curses.refresh を実行するまで画面に表示されない。

カーソルの表示/非表示

Curses.curs_set(番号)

カーソルを表示するには番号に 1、非表示にするには番号に 0 を入力する。

文字の読み込み

Curses.getch

標準入力から1文字読み込む。 いわゆるキー入力である。

色を使う

色を使うにはまず、Cursor.start_color を実行する。 

Cursor.start_color

カラーペアの設定

Curses.init_pair(カラーペア番号, 文字の色番号, 背景の色番号)

色を使うための準備として Curses.init_pair で文字と背景の色のペアをカラーペア番号（1以上の任意の整数）に設定する必要がある。 色番号は Curses::COLOR_BLUE や Curses::COLOR_BLACK などで指定するとよい。

色をつける

Curses.attrset(Curses.color_pair(カラーペア番号))

文字に色をつけて出力するには、文字の出力前にカラーペア番号から選択する。

プログラム例

プログラム例1

プログラム curses1.rb は仮想端末の画面の四隅と中央に文字を出力する。

curses1.rb
  2. #!/usr/koeki/bin/ruby
  3. # -*- coding: utf-8 -*-
  4.  
  5. require "curses"
  6.  
  7. # Cursesの初期化
  8. Curses.init_screen
  9.  
  10. begin
  11.   # 左上に"A"を出力
  12.   Curses.setpos(0, 0)
  13.   Curses.addch("A")
  14.  
  15.   # 右上に"B"を出力
  16.   Curses.setpos(0, Curses.cols - 1)
  17.   Curses.addch("B")
  18.  
  19.   # 左下に"C"を出力
  20.   Curses.setpos(Curses.lines - 1, 0)
  21.   Curses.addch("C")
  22.  
  23.   # 右下に"D"を出力
  24.   Curses.setpos(Curses.lines - 1, Curses.cols - 1)
  25.   Curses.addch("D")
  26.  
  27.   # 中央に"O"を出力
  28.   Curses.setpos(Curses.lines / 2, Curses.cols / 2)
  29.   Curses.addch("O")
  30.  
  31.   # 画面表示を更新
  32.   Curses.refresh
  33.  
  34.   # キー入力があるまで待つ
  35.   Curses.getch
  36.  
  37. ensure
  38.   # Cursesの終了処理
  39.   Curses.close_screen
  40. end

プログラム例2

プログラム curses2.rb は文字と背景の色を変えながら文字列を出力する。

curses2.rb
  2. #!/usr/koeki/bin/ruby
  3. # -*- coding: utf-8 -*-
  4.  
  5. require "curses"
  6.  
  7. # Cursesの初期化
  8. Curses.init_screen
  9.  
  10. begin
  11.   # 色の使用開始
  12.   Curses.start_color
  13.  
  14.   # カラーペア番号を設定
  15.   # 背景色を黒
  16.   Curses.init_pair( 1, Curses::COLOR_BLUE,    Curses::COLOR_BLACK)
  17.   Curses.init_pair( 2, Curses::COLOR_CYAN,    Curses::COLOR_BLACK)
  18.   Curses.init_pair( 3, Curses::COLOR_GREEN,   Curses::COLOR_BLACK)
  19.   Curses.init_pair( 4, Curses::COLOR_MAGENTA, Curses::COLOR_BLACK)
  20.   Curses.init_pair( 5, Curses::COLOR_RED,     Curses::COLOR_BLACK)
  21.   Curses.init_pair( 6, Curses::COLOR_WHITE,   Curses::COLOR_BLACK)
  22.   Curses.init_pair( 7, Curses::COLOR_YELLOW,  Curses::COLOR_BLACK)
  23.   # 文字色を黒
  24.   Curses.init_pair( 8, Curses::COLOR_BLACK,   Curses::COLOR_BLUE)
  25.   Curses.init_pair( 9, Curses::COLOR_BLACK,   Curses::COLOR_CYAN)
  26.   Curses.init_pair(10, Curses::COLOR_BLACK,   Curses::COLOR_GREEN)
  27.   Curses.init_pair(11, Curses::COLOR_BLACK,   Curses::COLOR_MAGENTA)
  28.   Curses.init_pair(12, Curses::COLOR_BLACK,   Curses::COLOR_RED)
  29.   Curses.init_pair(13, Curses::COLOR_BLACK,   Curses::COLOR_WHITE)
  30.   Curses.init_pair(14, Curses::COLOR_BLACK,   Curses::COLOR_YELLOW)
  31.  
  32.   # カラーペア番号で順に処理
  33.   1.upto(14) do |i|
  34.     # 文字の色をセット
  35.     Curses.attrset(Curses.color_pair(i))
  36.  
  37.     # 文字列を出力
  38.     Curses.setpos(i, 0)
  39.     Curses.addstr(sprintf("カラーペア番号 %d", i))
  40.   end
  41.  
  42.   # 画面表示を更新
  43.   Curses.refresh
  44.  
  45.   # キー入力があるまで待つ
  46.   Curses.getch
  47.  
  48. ensure
  49.   # Cursesの終了処理
  50.   Curses.close_screen
  51. end

プログラム例3

プログラム curses3.rb はカーソルキーで “x” を移動する。 他のキーを押すと終了する。

curses3.rb
  2. #!/usr/koeki/bin/ruby
  3. # -*- coding: utf-8 -*-
  4.  
  5. require "curses"
  6.  
  7. # Cursesの初期化
  8. Curses.init_screen
  9.  
  10. begin
  11.   # 初期座標
  12.   x = y = 0
  13.  
  14.   # カーソルを非表示
  15.   Curses.curs_set(0)
  16.  
  17.   # 入力文字を非表示
  18.   Curses.noecho
  19.  
  20.   # キーパッドを有効にする
  21.   Curses.stdscr.keypad(true)
  22.  
  23.   # Enterキーが押されるまでループ
  24.   while 1
  25.     # (x, y) に文字を出力
  26.     Curses.setpos(y, x)
  27.     Curses.addch("x")
  28.  
  29.     # 画面表示を更新
  30.     Curses.refresh
  31.  
  32.     # キー入力があるまで待つ
  33.     c = Curses.getch
  34.  
  35.     # (x, y) の文字を削除
  36.     Curses.setpos(y, x)
  37.     Curses.delch
  38.  
  39.     # キー判定
  40.     case c
  41.     when Curses::KEY_UP         # 「↑」キー
  42.       # 一番上の行でなければ上に移動
  43.       if y > 0
  44.         y -= 1
  45.       end
  46.     when Curses::KEY_DOWN       # 「↓」キー
  47.       # 一番下の行でなければ下に移動
  48.       if y < Curses.lines - 1
  49.         y += 1
  50.       end
  51.     when Curses::KEY_RIGHT      # 「→」キー
  52.       # 一番右の列でなければ右に移動
  53.       if x < Curses.cols - 1
  54.         x += 1
  55.       end
  56.     when Curses::KEY_LEFT       # 「←」キー
  57.       # 一番左の列でなければ左に移動
  58.       if x > 0
  59.         x -= 1
  60.       end
  61.     else
  62.       # 他のキーでループを抜ける
  63.       break
  64.     end
  65.   end
  66.  
  67. ensure
  68.   # Cursesの終了処理
  69.   Curses.close_screen
  70. end