ncurses(3x) ncurses(3x)
ncurses - 画面出力を操作し最適化するソフトウェア・パッケージ
#include <curses.h>
ncurses ライブラリ・ルーチン群は、妥当な効率で文字画面を 更新する、端末に独立な手段を提供します。この実装は 「new curses」(ncurses) といい、 開発が終了した古典的な 4.4BSD curses を置き換えるものとして認められています。 この文書は、 ncurses バージョン 6.0 (パッチ 20160130) に ついて説明しています。 ncurses ライブラリは、 System V Release 4 UNIX の curses ライブラリと XPG4 (X/Open Portability Guide) curses (XSI curses としても知られる) をエミュレートします。XSI は X/Open System Interfaces Extension を意味します。ncurses ライブラリは、ソ ースを自由に再配布することができます。SVr4 curses との違い は、以下の拡張機能と移植性の節にまとめてあり、個別マニュア ル・ページ内の拡張機能、移植性、バグの節にそれぞれ詳細を記 しています。 ncurses ライブラリは、多くの便利な拡張機能を提供します。 つまり、単なるアドオン・ライブラリでは実現できず、 ライブラリの内部にアクセスする必要がある機能です。 ncurses のルーチンを使うためには、プログラムを -lncurses オプションか、(すでに作成されていれば)デバッグ用ライブラリ -lncurses_g オプション付きでリンクしなければなりません。 (システムによっては -lcurses と -lcurses_g という (訳注: オプションが必要となるような)名でライブラ リがインストールされているかもしれません。) ncurses_g ライ ブラリは、curses の操作を記録したトレース・ログを('trace' と呼ばれるファイルをカレント・ディレクトリに)作成します。 構成の変更の節を参照してください。 ncurses パッケージは、全画面表示、ウィンドウとパッドの操作、 ウィンドウとパッドへの出力、端末入力の読み込み、端末および curses 入出力オプションの制御、環境問い合わせルーチン、色の 取り扱い、ファンクションキー・ラベルの使用、terminfo の機能、 そして低レベル端末操作ルーチンへのアクセスをサポートします。
このライブラリは、呼び出し側のプログラムが初期化したロケー ルを使用します。通常は setlocale を用いて setlocale(LC_ALL, ""); のように行います。 ロケールが初期化されていない場合、古いプログラムが動作する ように、ライブラリは文字が ISO-8859-1 で印字可能だとみなし ます。呼び出し側でロケールを初期化しなければなりませんし、 ロケールが設定されていない時にはライブラリの具体的な詳細動 作をあてにしてはいけません。 ライブラリを初期化するため、他のウィンドウ・画面操作ルーチ ンを使う前に initscr 関数または newterm 関数を呼ぶ必要があ ります。プログラムを終了する前には、 endwin ルーチンを呼ぶ 必要があります。 エコー(ほとんどの対話的な画面指向のプログラムはこれを求め ますが)なしに逐一入力文字を取得するには、次の一連の処理を用 います。 initscr(); cbreak(); noecho(); 多くのプログラムは、さらに次の一連の処理を用いるでしょう。 nonl(); intrflush(stdscr, FALSE); keypad(stdscr, TRUE); curses プログラムを実行する前に、端末のタブ・ストップが設 定され、もし定義されていれば端末の初期化文字列が出力されて いなければなりません。これは、シェルの環境変数 TERM をエク スポートした後、 tput init コマンドを実行することで実行でき ます。通常は tset(1) が設定元になります。[詳細は terminfo(5) を参照してください。]
ncurses ライブラリは、画面の全部または一部分に表示される二 次元の文字配列と考えられる、ウィンドウと呼ぶデータ構造を扱 うことができます。端末画面の大きさを持つ stdscr と呼ばれる デフォルトのウィンドウが供給されます。他のウィンドウは newwin で作られるでしょう。 curses はウィンドウの重なりを扱うことはできないことに注意 してください。それは panel(3x) ライブラリが扱います。これは stdscr を使うか、画面を分割してウィンドウを敷き詰めるか、stdscr を全く使わないか、しかできないことを意味します。curses と panel を混用すると、予期しない、望ましくない効果を生じるでしょう。 ウィンドウは WINDOW * 型で宣言された変数によって参照されま す。これらのデータ構造(ウィンドウ)は、このページや ncurses マニュアル・ページの各所に書かれているルーチンで操作します。 そのなかでも、最も基本的なルーチンは move と addch です。こ れらのルーチンのより一般的なバージョンは対象となるウィンド ウを指定することができ、 w で始まる名前でライブラリに含まれ ています。w で始まらないルーチンは stdscr に作用します。 ウィンドウ操作ルーチンを使った後、refresh を呼ぶと、 stdscr のとおりの画面にするように curses に指示します。ウィンドウ 内の文字は実際には(文字と属性のデータを持つ) chtype 型なの で、その文字に関する他の情報も一緒に格納されるでしょう。 パッド(pad)と呼ぶ特別なウィンドウの操作をすることもできます。 パッドは画面のサイズに制約されないウィンドウで、その内容は 必ずしも完全に表示されません。詳しくは curs_pad(3x) を参照 してください。 拡張表示機能を持つ端末では、単に画面に文字を表示するだけで なく、下線つき、反転、カラーのようなモードで文字を強調表示 するように、描画属性と色がサポートされるでしょう。出力用に 罫線文字が宣言されるでしょう。入力では、 curses は矢印キー とファンクションキーが出すエスケープ・シーケンスを単一の値 に変換します。描画属性、罫線文字、入力キー値には、 A_REVERSE, ACS_HLINE, KEY_LEFT のように、 <curses.h> で定義された名前 が使われます。
環境変数 LINES と COLUMNS が設定されると、 またはプログラムがウィンドウ環境で実行されると、環境中の 行と桁の情報で terminfo が読み取った情報を上書きします。 これは、画面のサイズが変更可能な、例えば AT&T 630 layer 内で 実行しているプログラムに影響します。(環境変数と識別子を参照) 環境変数 TERMINFO が定義されていると、 curses を使うすべて のプログラムは、標準の場所を調べる前にローカルの端末定義を 調べます。例えば、 TERM が att4424 に設定されていると、コン パイルされた端末定義は /usr/share/terminfo/a/att4424 にあります。 ( a は att4424 の最初の文字を取ったもので、ディレクトリが肥大 化するのを防いでいます。) しかし、 TERMINFO が $HOME/myterms に設定されていると、 curses はまず $HOME/myterms/a/att4424 を調べます。失敗すると、次に /usr/share/terminfo/a/att4424 を調べます。 これはテスト用の定義を開発する時や、 /usr/share/terminfo へ の書き込み許可がない時に便利です。 整数変数 LINES と COLS は <curses.h> で定義され、 initscr によって画面全体のサイズが与えられます。定数 TRUE と FALSE はそれぞれ 1 と 0 の値を持ちます。 curses のルーチンはまた、 WINDOW * 型の変数 curscr を定義 して、不要なデータを含んだ画面の消去や再描画など、特定の低 レベル操作に使用します。 curscr を使うのは数少ないルーチンの みです。
curses ルーチンの大半は、2つかそれ以上のバージョンを持ちま す。 w で始まるルーチンは引数にウィンドウが必要です。 p で 始まるルーチンは引数にパッドが必要です。どちらもつかないル ーチンは、一般に stdscr を使います。 mv で始まるルーチンは、しかるべき動作の前に移動する先の座 標 y と x が必要です。mv で始まるルーチンは、 move を呼んで から他のルーチンを呼ぶことを意味します。y 座標は常に(ウィン ドウの)行を表し、 x は常に桁を表します。左上隅は常に (0,0) であり、 (1,1) ではありません。 mvw で始まるルーチンは、ウィンドウ引数と y と x の座標をす べて取ります。常に座標の前にウィンドウ引数を指定します。 いずれの場合にも、 win は作用するウィンドウ、 pad は作用す るパッドであり、共に WINDOW 型へのポインタです。 オプション設定ルーチンは、 TRUE か FALSE の値を持つブール 値のフラグ bf を必要とします。 bf は常に bool 型です。WINDOW, SCREEN, bool, chtype など、このライブラリ・ルーチンで使われ る大半のデータ型は、 <curses.h> で定義されています。terminfo ルーチン群で使われる TERMINAL などの型は <term.h> で定義さ れています。 マニュアルのこのページでは、このライブラリのどのような構成 でも現れるような関数について説明します。このライブラリには 次の 2つの一般的な構成があります。 ncurses 「ノーマル」ライブラリであり、 8ビット文字を取り扱 います。ノーマル( 8ビット)ライブラリは文字を属性と 組み合わせて chtype 型データに格納します。 (対応する文字のない)属性のみのデータは、 chtype 型 か、等価な attr_t 型のデータとして格納します。どち らの場合でも、データは整数の値として格納されます。 WINDOW の各マス(行と桁)は 1つの chtype 型データに格 納されます。 ncursesw いわゆる「ワイド」ライブラリであり、マルチバイト文 字を取り扱います。(構成の変更を参照) 「ワイド」ラ イブラリは「ノーマル」ライブラリのルーチンをすべて 含んでいます。これに、マルチバイト文字を格納するた めのデータ型を使うルーチンが 3分の1ほど多く加えられ ています。 cchar_t chtype に対応しますが、 1つの整数値に収まらな いデータを格納するため、構造体になっています。 文字には整数の最大値以上が必要で、 1マスに 2文 字以上が入るかもしれません。描画属性と色は、構 造体の別のメンバに格納されます。 WINDOW の各マス(行と桁)は 1つの cchar_t 型デ ータに格納されます。 wchar_t ワイド文字を 1つ格納します。 chtype に似て、 こちらは整数でしょう。 wint_t wchar_t を 1つ、または WEOF を格納します。両 者は同じサイズかもしれませんが、同一ではありま せん。 「ワイド」ライブラリは、「ノーマル」ライブラリのル ーチンに類似した新しい関数を提供します。大半のノー マル/ワイドの変種に関しては、 "_w" をはさむという命 名規則があります。例えば、 waddch は wadd_wch にな ります。
下記は各 curses ルーチンと、その説明が記載されたマニュアル ・ページ名の表です。 (訳注: ここに記載のないルーチンは curs_threads(3x), curs_sp_funcs(3x) を参照してください) *印のルーチンは ncurses 独自で、 XPG4 や 現在の SVr4 には 記載されていません。 curses ルーチン名 マニュアル・ページ名 -------------------------------------------- COLOR_PAIR curs_color(3x) PAIR_NUMBER curs_attr(3x) _nc_free_and_exit curs_memleaks(3x)* _nc_freeall curs_memleaks(3x)* _nc_tracebits curs_trace(3x)* _traceattr curs_trace(3x)* _traceattr2 curs_trace(3x)* _tracechar curs_trace(3x)* _tracechtype curs_trace(3x)* _tracechtype2 curs_trace(3x)* _tracedump curs_trace(3x)* _tracef curs_trace(3x)* _tracemouse curs_trace(3x)* add_wch curs_add_wch(3x) add_wchnstr curs_add_wchstr(3x) add_wchstr curs_add_wchstr(3x) addch curs_addch(3x) addchnstr curs_addchstr(3x) addchstr curs_addchstr(3x) addnstr curs_addstr(3x) addnwstr curs_addwstr(3x) addstr curs_addstr(3x) addwstr curs_addwstr(3x) assume_default_colors default_colors(3x)* attr_get curs_attr(3x) attr_off curs_attr(3x) attr_on curs_attr(3x) attr_set curs_attr(3x) attroff curs_attr(3x) attron curs_attr(3x) attrset curs_attr(3x) baudrate curs_termattrs(3x) beep curs_beep(3x) bkgd curs_bkgd(3x) bkgdset curs_bkgd(3x) bkgrnd curs_bkgrnd(3x) bkgrndset curs_bkgrnd(3x) border curs_border(3x) border_set curs_border_set(3x) box curs_border(3x) box_set curs_border_set(3x) can_change_color curs_color(3x) cbreak curs_inopts(3x) chgat curs_attr(3x) clear curs_clear(3x) clearok curs_outopts(3x) clrtobot curs_clear(3x) clrtoeol curs_clear(3x) color_content curs_color(3x) color_set curs_attr(3x) copywin curs_overlay(3x) curs_set curs_kernel(3x) curses_version curs_extend(3x)* def_prog_mode curs_kernel(3x) def_shell_mode curs_kernel(3x) define_key define_key(3x)* del_curterm curs_terminfo(3x) delay_output curs_util(3x) delch curs_delch(3x) deleteln curs_deleteln(3x) delscreen curs_initscr(3x) delwin curs_window(3x) derwin curs_window(3x) doupdate curs_refresh(3x) dupwin curs_window(3x) echo curs_inopts(3x) echo_wchar curs_add_wch(3x) echochar curs_addch(3x) endwin curs_initscr(3x) erase curs_clear(3x) erasechar curs_termattrs(3x) erasewchar curs_termattrs(3x) filter curs_util(3x) flash curs_beep(3x) flushinp curs_util(3x) get_wch curs_get_wch(3x) get_wstr curs_get_wstr(3x) getattrs curs_attr(3x) getbegx curs_legacy(3x)* getbegy curs_legacy(3x)* getbegyx curs_getyx(3x) getbkgd curs_bkgd(3x) getbkgrnd curs_bkgrnd(3x) getcchar curs_getcchar(3x) getch curs_getch(3x) getcurx curs_legacy(3x)* getcury curs_legacy(3x)* getmaxx curs_legacy(3x)* getmaxy curs_legacy(3x)* getmaxyx curs_getyx(3x) getmouse curs_mouse(3x)* getn_wstr curs_get_wstr(3x) getnstr curs_getstr(3x) getparx curs_legacy(3x)* getpary curs_legacy(3x)* getparyx curs_getyx(3x) getstr curs_getstr(3x) getsyx curs_kernel(3x) getwin curs_util(3x) getyx curs_getyx(3x) halfdelay curs_inopts(3x) has_colors curs_color(3x) has_ic curs_termattrs(3x) has_il curs_termattrs(3x) has_key curs_getch(3x)* hline curs_border(3x) hline_set curs_border_set(3x) idcok curs_outopts(3x) idlok curs_outopts(3x) immedok curs_outopts(3x) in_wch curs_in_wch(3x) in_wchnstr curs_in_wchstr(3x) in_wchstr curs_in_wchstr(3x) inch curs_inch(3x) inchnstr curs_inchstr(3x) inchstr curs_inchstr(3x) init_color curs_color(3x) init_pair curs_color(3x) initscr curs_initscr(3x) innstr curs_instr(3x) innwstr curs_inwstr(3x) ins_nwstr curs_ins_wstr(3x) ins_wch curs_ins_wch(3x) ins_wstr curs_ins_wstr(3x) insch curs_insch(3x) insdelln curs_deleteln(3x) insertln curs_deleteln(3x) insnstr curs_insstr(3x) insstr curs_insstr(3x) instr curs_instr(3x) intrflush curs_inopts(3x) inwstr curs_inwstr(3x) is_cleared curs_opaque(3x)* is_idcok curs_opaque(3x)* is_idlok curs_opaque(3x)* is_immedok curs_opaque(3x)* is_keypad curs_opaque(3x)* is_leaveok curs_opaque(3x)* is_linetouched curs_touch(3x) is_nodelay curs_opaque(3x)* is_notimeout curs_opaque(3x)* is_pad curs_opaque(3x)* is_scrollok curs_opaque(3x)* is_subwin curs_opaque(3x)* is_syncok curs_opaque(3x)* is_term_resized resizeterm(3x)* is_wintouched curs_touch(3x) isendwin curs_initscr(3x) key_defined key_defined(3x)* key_name curs_util(3x) keybound keybound(3x)* keyname curs_util(3x) keyok keyok(3x)* keypad curs_inopts(3x) killchar curs_termattrs(3x) killwchar curs_termattrs(3x) leaveok curs_outopts(3x) longname curs_termattrs(3x) mcprint curs_print(3x)* meta curs_inopts(3x) mouse_trafo curs_mouse(3x)* mouseinterval curs_mouse(3x)* mousemask curs_mouse(3x)* move curs_move(3x) mvadd_wch curs_add_wch(3x) mvadd_wchnstr curs_add_wchstr(3x) mvadd_wchstr curs_add_wchstr(3x) mvaddch curs_addch(3x) mvaddchnstr curs_addchstr(3x) mvaddchstr curs_addchstr(3x) mvaddnstr curs_addstr(3x) mvaddnwstr curs_addwstr(3x) mvaddstr curs_addstr(3x) mvaddwstr curs_addwstr(3x) mvchgat curs_attr(3x) mvcur curs_terminfo(3x) mvdelch curs_delch(3x) mvderwin curs_window(3x) mvget_wch curs_get_wch(3x) mvget_wstr curs_get_wstr(3x) mvgetch curs_getch(3x) mvgetn_wstr curs_get_wstr(3x) mvgetnstr curs_getstr(3x) mvgetstr curs_getstr(3x) mvhline curs_border(3x) mvhline_set curs_border_set(3x) mvin_wch curs_in_wch(3x) mvin_wchnstr curs_in_wchstr(3x) mvin_wchstr curs_in_wchstr(3x) mvinch curs_inch(3x) mvinchnstr curs_inchstr(3x) mvinchstr curs_inchstr(3x) mvinnstr curs_instr(3x) mvinnwstr curs_inwstr(3x) mvins_nwstr curs_ins_wstr(3x) mvins_wch curs_ins_wch(3x) mvins_wstr curs_ins_wstr(3x) mvinsch curs_insch(3x) mvinsnstr curs_insstr(3x) mvinsstr curs_insstr(3x) mvinstr curs_instr(3x) mvinwstr curs_inwstr(3x) mvprintw curs_printw(3x) mvscanw curs_scanw(3x) mvvline curs_border(3x) mvvline_set curs_border_set(3x) mvwadd_wch curs_add_wch(3x) mvwadd_wchnstr curs_add_wchstr(3x) mvwadd_wchstr curs_add_wchstr(3x) mvwaddch curs_addch(3x) mvwaddchnstr curs_addchstr(3x) mvwaddchstr curs_addchstr(3x) mvwaddnstr curs_addstr(3x) mvwaddnwstr curs_addwstr(3x) mvwaddstr curs_addstr(3x) mvwaddwstr curs_addwstr(3x) mvwchgat curs_attr(3x) mvwdelch curs_delch(3x) mvwget_wch curs_get_wch(3x) mvwget_wstr curs_get_wstr(3x) mvwgetch curs_getch(3x) mvwgetn_wstr curs_get_wstr(3x) mvwgetnstr curs_getstr(3x) mvwgetstr curs_getstr(3x) mvwhline curs_border(3x) mvwhline_set curs_border_set(3x) mvwin curs_window(3x) mvwin_wch curs_in_wch(3x) mvwin_wchnstr curs_in_wchstr(3x) mvwin_wchstr curs_in_wchstr(3x) mvwinch curs_inch(3x) mvwinchnstr curs_inchstr(3x) mvwinchstr curs_inchstr(3x) mvwinnstr curs_instr(3x) mvwinnwstr curs_inwstr(3x) mvwins_nwstr curs_ins_wstr(3x) mvwins_wch curs_ins_wch(3x) mvwins_wstr curs_ins_wstr(3x) mvwinsch curs_insch(3x) mvwinsnstr curs_insstr(3x) mvwinsstr curs_insstr(3x) mvwinstr curs_instr(3x) mvwinwstr curs_inwstr(3x) mvwprintw curs_printw(3x) mvwscanw curs_scanw(3x) mvwvline curs_border(3x) mvwvline_set curs_border_set(3x) napms curs_kernel(3x) newpad curs_pad(3x) newterm curs_initscr(3x) newwin curs_window(3x) nl curs_outopts(3x) nocbreak curs_inopts(3x) nodelay curs_inopts(3x) noecho curs_inopts(3x) nofilter curs_util(3x)* nonl curs_outopts(3x) noqiflush curs_inopts(3x) noraw curs_inopts(3x) notimeout curs_inopts(3x) overlay curs_overlay(3x) overwrite curs_overlay(3x) pair_content curs_color(3x) pechochar curs_pad(3x) pnoutrefresh curs_pad(3x) prefresh curs_pad(3x) printw curs_printw(3x) putp curs_terminfo(3x) putwin curs_util(3x) qiflush curs_inopts(3x) raw curs_inopts(3x) redrawwin curs_refresh(3x) refresh curs_refresh(3x) reset_prog_mode curs_kernel(3x) reset_shell_mode curs_kernel(3x) resetty curs_kernel(3x) resize_term resizeterm(3x)* resizeterm resizeterm(3x)* restartterm curs_terminfo(3x) ripoffline curs_kernel(3x) savetty curs_kernel(3x) scanw curs_scanw(3x) scr_dump curs_scr_dump(3x) scr_init curs_scr_dump(3x) scr_restore curs_scr_dump(3x) scr_set curs_scr_dump(3x) scrl curs_scroll(3x) scroll curs_scroll(3x) scrollok curs_outopts(3x) set_curterm curs_terminfo(3x) set_term curs_initscr(3x) setcchar curs_getcchar(3x) setscrreg curs_outopts(3x) setsyx curs_kernel(3x) setterm curs_terminfo(3x) setupterm curs_terminfo(3x) slk_attr curs_slk(3x)* slk_attr_off curs_slk(3x) slk_attr_on curs_slk(3x) slk_attr_set curs_slk(3x) slk_attroff curs_slk(3x) slk_attron curs_slk(3x) slk_attrset curs_slk(3x) slk_clear curs_slk(3x) slk_color curs_slk(3x) slk_init curs_slk(3x) slk_label curs_slk(3x) slk_noutrefresh curs_slk(3x) slk_refresh curs_slk(3x) slk_restore curs_slk(3x) slk_set curs_slk(3x) slk_touch curs_slk(3x) standend curs_attr(3x) standout curs_attr(3x) start_color curs_color(3x) subpad curs_pad(3x) subwin curs_window(3x) syncok curs_window(3x) term_attrs curs_termattrs(3x) termattrs curs_termattrs(3x) termname curs_termattrs(3x) tgetent curs_termcap(3x) tgetflag curs_termcap(3x) tgetnum curs_termcap(3x) tgetstr curs_termcap(3x) tgoto curs_termcap(3x) tigetflag curs_terminfo(3x) tigetnum curs_terminfo(3x) tigetstr curs_terminfo(3x) tiparm curs_terminfo(3x)* timeout curs_inopts(3x) touchline curs_touch(3x) touchwin curs_touch(3x) tparm curs_terminfo(3x) tputs curs_termcap(3x) tputs curs_terminfo(3x) trace curs_trace(3x)* typeahead curs_inopts(3x) unctrl curs_util(3x) unget_wch curs_get_wch(3x) ungetch curs_getch(3x) ungetmouse curs_mouse(3x)* untouchwin curs_touch(3x) use_default_colors default_colors(3x)* use_env curs_util(3x) use_extended_names curs_extend(3x)* use_legacy_coding legacy_coding(3x)* use_tioctl curs_util(3x) vid_attr curs_terminfo(3x) vid_puts curs_terminfo(3x) vidattr curs_terminfo(3x) vidputs curs_terminfo(3x) vline curs_border(3x) vline_set curs_border_set(3x) vw_printw curs_printw(3x) vw_scanw curs_scanw(3x) vwprintw curs_printw(3x) vwscanw curs_scanw(3x) wadd_wch curs_add_wch(3x) wadd_wchnstr curs_add_wchstr(3x) wadd_wchstr curs_add_wchstr(3x) waddch curs_addch(3x) waddchnstr curs_addchstr(3x) waddchstr curs_addchstr(3x) waddnstr curs_addstr(3x) waddnwstr curs_addwstr(3x) waddstr curs_addstr(3x) waddwstr curs_addwstr(3x) wattr_get curs_attr(3x) wattr_off curs_attr(3x) wattr_on curs_attr(3x) wattr_set curs_attr(3x) wattroff curs_attr(3x) wattron curs_attr(3x) wattrset curs_attr(3x) wbkgd curs_bkgd(3x) wbkgdset curs_bkgd(3x) wbkgrnd curs_bkgrnd(3x) wbkgrndset curs_bkgrnd(3x) wborder curs_border(3x) wborder_set curs_border_set(3x) wchgat curs_attr(3x) wclear curs_clear(3x) wclrtobot curs_clear(3x) wclrtoeol curs_clear(3x) wcolor_set curs_attr(3x) wcursyncup curs_window(3x) wdelch curs_delch(3x) wdeleteln curs_deleteln(3x) wecho_wchar curs_add_wch(3x) wechochar curs_addch(3x) wenclose curs_mouse(3x)* werase curs_clear(3x) wget_wch curs_get_wch(3x) wget_wstr curs_get_wstr(3x) wgetbkgrnd curs_bkgrnd(3x) wgetch curs_getch(3x) wgetdelay curs_opaque(3x)* wgetn_wstr curs_get_wstr(3x) wgetnstr curs_getstr(3x) wgetparent curs_opaque(3x)* wgetscrreg curs_opaque(3x)* wgetstr curs_getstr(3x) whline curs_border(3x) whline_set curs_border_set(3x) win_wch curs_in_wch(3x) win_wchnstr curs_in_wchstr(3x) win_wchstr curs_in_wchstr(3x) winch curs_inch(3x) winchnstr curs_inchstr(3x) winchstr curs_inchstr(3x) winnstr curs_instr(3x) winnwstr curs_inwstr(3x) wins_nwstr curs_ins_wstr(3x) wins_wch curs_ins_wch(3x) wins_wstr curs_ins_wstr(3x) winsch curs_insch(3x) winsdelln curs_deleteln(3x) winsertln curs_deleteln(3x) winsnstr curs_insstr(3x) winsstr curs_insstr(3x) winstr curs_instr(3x) winwstr curs_inwstr(3x) wmouse_trafo curs_mouse(3x)* wmove curs_move(3x) wnoutrefresh curs_refresh(3x) wprintw curs_printw(3x) wredrawln curs_refresh(3x) wrefresh curs_refresh(3x) wresize wresize(3x)* wscanw curs_scanw(3x) wscrl curs_scroll(3x) wsetscrreg curs_outopts(3x) wstandend curs_attr(3x) wstandout curs_attr(3x) wsyncdown curs_window(3x) wsyncup curs_window(3x) wtimeout curs_inopts(3x) wtouchln curs_touch(3x) wunctrl curs_util(3x) wvline curs_border(3x) wvline_set curs_border_set(3x)
整数値を返すルーチンは、特記がない限り、失敗した場合には ERR を、正常終了した場合にはその他の整数値を返します。 原則として、ルーチンはパラメータとして渡されたヌル・ポイン タをチェックし、これをエラーとして扱います。 setscrreg, wsetscrreg, getyx, getbegyx, getmaxyx 以外のす べてのマクロは、 w バージョンの値を返します。setscrreg, wsetscrreg, getyx, getbegyx, getmaxyx の戻り値は未定義です。 (ですから代入文の右辺値として使ってはいけません。) ポインタを返すルーチンは、エラー時に NULL を返します。
ncurses ライブラリの実行時の動作を変更するためには、以下の 環境変数や識別子が有用です。最も重要な環境変数についてはす でに詳説しました。
アプリケーションが出力をファイルへとリダイレクトした時に、 デバッグ用ライブラリはこの環境変数を調べます。この環境変数 の数値はボーレートに使われます。数値が見つからない場合には、 ncurses は 9600 を使います。これによって、ボーレートに依存 するコストを考慮する繰り返し可能なテストケースが作成できま す。
設定すると、読み込んだ terminfo 項目の制御文字(つまり cmdch 機能で指定されたもの)が出現したとき、この変数の値に 変更します。この機能を提供する terminfo 項目はごくわずかしか ありません。 この名前は開発環境でCコンパイラの名前を表すためにも使われ るため、もし 1文字でなかった場合には ncurses はこれを無視し ます。
画面の幅を文字単位で指定します。ウィンドウ環境で実行されて いるアプリケーションは、通常、実行中のウィンドウの幅を取得 することができます。 COLUMNS の値と端末の画面サイズがどちら も取得できない場合、 ncurses は terminfo データベースで指定 された値(すなわち、端末機能 cols )を使用します。 アプリケーションが画面の正しいサイズを使うかどうかは重要な ことです。これは常に可能ではありません。アプリケーションは NAWS (Negotiations About Window Size) を守らないホスト上で 実行されることがあるため、もしくは一時的に別のユーザーとし て実行させることもあるためです。しかし、 COLUMNS と/または LINES を設定すると、ライブラリがオペレーティング・システム から取得した画面のサイズを無効にします。 COLUMNS か LINES の識別子は独立に指定されているかもしれま せん。これは主に歴史的で不便な仕様を回避する便宜のためです。 たとえば、 xterm は一般に 65 行の画面を指定します。エミュレ ーションとして動作する端末が最良の結果を得るためには、 lines と cols は端末記述で指定すべきではありません。 画面サイズを決めるにあたって、すべての外部環境 (ただしシス テム・コールを除く) の使用を無効にするためには、 use_env 関 数を使ってください、 COLUMNS か LINES を更新して、システム ・コールまたは端末データベースから得た画面のサイズに一致さ せるには、 use_tioctl 関数を使ってください。
ncurses が文字のシーケンス、たとえばファンクションキー、を 待つ時間の合計をミリ秒単位で指定します。デフォルト値は 1000 ミリ秒で、ほとんどの用途には十分です。しかし、例外的なアプ リケーションにも適合するように、変更可能にしてあります。 この値を変更しようとする最もありふれた実例は、遅いホストに 合わせて動作する場面、例えばネットワーク上での処理でしょう。 ホストが文字を十分速く読み取れないとき、それはあたかも端末 が文字を十分速く送れないのと同じ効果を持つでしょう。ライブ ラリはまだタイムアウトに遭うでしょう。 xterm のマウス・イベントは xterm から受け取った文字のシー ケンスから組み立てられていることに注意してください。アプリ ケーションが複数回のクリックを多用するなら、このデフォルト 値を長くしたいと思うでしょう、なぜなら複数回のクリックにも 1回のクリックと同じようにタイムアウトが適用されるからです。 この環境変数についてつけ加えると、この実装は同じ名前の広域 変数も用意しています。ポータブル・アプリケーションは、どち らの形でも ESCDELAY の存在に頼るべきではありませんが、広域 変数よりむしろ環境変数を設定するほうがアプリケーションのコ ンパイル時に問題を引き起こしません。
ncurses にホームディレクトリの場所を知らせます。 ncurses は次の場所から補助的に端末記述を読み書きすることがあります。 $HOME/.termcap $HOME/.terminfo
COLUMNS と同様に、こちらは画面の高さを文字単位で指定します。 詳しい説明は COLUMNS を参照してください。
OS/2 EMX ポートにのみ適用されます。マウスのボタンの順序を 指定します。 OS/2 は他のプラットフォームに無頓着に 3ボタン マウスに番号を付けています。 1 = 左 2 = 右 3 = 中 この変数はマウスをカスタマイズします。この変数は 1 から 3 の 3つの数字を好きな順序で並べたものでなければなりません。 例えば、 123 とか 321 です。指定がない場合、 ncurses は 132 を使います。
端末のデフォルトの色は黒地に白の文字というコンパイル時の仮 定を無効にします。(default_colors(3x) 参照) この環境変数を 用い、 2つの要素を持つリスト — 前景色,背景色 — を示して、 前景色と背景色を設定することができます。たとえば、 ncurses に対して、色について何も仮定していないことを伝えるには、 "-1,-1" を設定します。黒地に緑にするには、"2,0" を設定します。 ゼロから terminfo の max_colors までのすべての正の値が許さ れます。
ncurses の MinGW ポートにのみ適用されます。 Console2 プログラムが Microsoft コンソール API 呼び出し CreateConsoleScreenBuffer を取り扱う方法には欠陥があります。 これを使うアプリケーションはハングします。しかし、座標をマッ ピングし、明示的に元の画面を保存・復元することで、この呼び 出しをシミュレートすることが可能です。環境変数 NCGDB を設定 すると同じ効果を持ちます。
GPM インターフェイスを使うように構成された ncurses にのみ 適用されます。 存在する場合、この環境変数は環境変数 TERM にマッチした 1つ またはそれ以上の端末名のリストです。空の値をセットすると、 GPM インターフェイスを無効にして、組み込みの xterm サポート などを使います。 この環境変数がない場合、 ncurses は TERM が "linux" を含む ならば GPM をオープンしようと試みます。
ncurses はカーソル移動の最適化の一部としてタブを使うこと があります。いくつかの場合、端末ドライバはこれらを正しく扱 わないかもしれません。この環境変数を設定すると、その機能を 無効にします。また、問題を避けるために stty 設定を調整する 方法もあります。
いくつかの端末は、強調その他の描画属性を正しく表示するため に特別な取り扱いを必要とするマジッククッキー機能を使ってい ます。この環境変数を設定することにより、これらの端末で全面 的に強調表示を禁止することができます。
terminfo データベースの端末記述の大半は物理的な「ハードウ ェア」端末向けに書かれています。多くの人々はウィンドウ環境 で動作する端末エミュレータと curses ベースのアプリケーショ ンを使っています。端末エミュレータはハードウェア端末の主要 な外観を複製できますが、両者の制約は同じではありません。ア プリケーションの見地からは、ハードウェア端末の主な制約はデ ータフローの制御、すなわちタイミングです。ハードウェア端末 が(フロー制御を行う)端末集配信装置にインターフェイスで接続 されない限り、ハードウェア端末(またはアプリケーション)はオ ーバーランしないようにデータフローを管理しなければなりませ ん。最も安価な(ハードウェア費用のかからない)方法は、画面の 消去などのように端末がゆっくりと行う処理の後に、プログラム が休み時間を入れることでフロー制御を行うことです。 結果として、大半の端末記述は( vt100 を含め)遅延時間が埋め 込まれています。これらの記述を使いたいと思うかもしれません が、性能低下のペナルティは払いたくないと思うでしょう。 環境変数 NCURSES_NO_PADDING を設定すると、必須のものを除い てパディングを無効化します。必須のパディングは flash などの ような特殊な制御シーケンスの一部として使われます。
この設定は廃止項目です。変更の前には o 5.9 patch 20120825 で始まり、 o 5.9 patch 20130126 に続きました。 ncurses は端末を初期化する間、バッファ付き出力を可能にして いました。( SVr4 curses でしているように)性能上の理由からこ うしていました。テスト用に、 ncurses およびある種のアプリケ ーションで、この機能がオプションとされていました。 NCURSES_ NO_SETBUF 変数を設定すると出力のバッファリングを無効にし、 本来の(通常は行バッファ付き)モードのままにしていました。 現在の実装では、 ncurses は自前のバッファリングを行うため、 この処置は必要ではありません。 ncurses は標準出力のバッファ リングを変更しません。 変更した理由は、割り込みやその他のシグナルに対する挙動をよ り安定にしたためです。ひとつの欠点は、一般的ではないある種 のプログラムが通常の stdio 呼び出しと ncurses 呼び出しを両 方混用しようとし、そして(通常)動作するということです。もは やこれは不可能です。 ncurses はバッファ付きの標準出力を使用 せず、(同じファイル記述子への)自前の出力を使用するからです。 特別な場合には、 putp のような低レベル呼び出しが標準出力を 使用します。しかし、高レベルの curses 呼び出しは標準出力を 使用しません。
ncurses ライブラリは初期化の間、 terminfo に書かれている VT100 の罫線(と、これに対応する代替文字セット機能)が欠落し ていると知られている、特別な場合をチェックします。具体的に は、UTF-8 ロケールで実行中に、 Linux console エミュレータと GNU Screen プログラムがこれらを無視するのです。 ncurses は、 環境変数 TERM をこれらのためにチェックします。その他の特別 な場合には、あなたがこの環境変数をセットしなければなりませ ん。これを行うことで ncurses に VT100 の罫線素片に対応する Unicode の値を使うよう指示します。それは上記の特別な場合に 働き、おそらく端末エミュレータにも働くでしょう。 この変数には非ゼロ値をセットしなければなりません。ゼロ(ま たは非数値)をセットすると、 "linux" と "screen" に対する特 別なチェックをしません。 この環境変数に代わる方法として、 ncurses は terminfo の拡 張機能である U8 を調べます。これは数値型の機能であり、 tic -x でコンパイルできます。例えば # 対応するフォントとともに VT100 のシフトイン/シフトアウト # が動作するよう変更された Linux console linux-vt100|linux console with VT100 line-graphics, U8#0, use=linux, # uxterm with vt100Graphics resource set to false # vt100Graphics 部品セットを不可にした uxterm xterm-utf8|xterm relying on UTF-8 line-graphics, U8#1, use=xterm, The name "U8" is chosen to be two characters, to permit it to be used by applications that use ncurses' termcap interface. ncurses の termcap インターフェイスを使うアプリケーション から使えるように、 "U8" という名は 2文字となるように選ばれ ています。
初期化の間に、 ncurses デバッグ用ライブラリは環境変数 NCURSES_ TRACE を調べます。もしこれが数値として定義されていると、 ncurses はその数値を引数として trace 関数を呼びます。 curses.h で定義されている引数の値は、いくつかの情報の種類 を与えます。トレースを有効にして実行しているとき、アプリケ ーションはカレント・ディレクトリにファイル trace を書き込み ます。 詳しくは curs_trace(3x) を参照してください。
使用中の端末の種類を示します。それぞれの端末の種類ははっき り異なりますが、同一のものも多数あります。 TERM は一般的に端末エミュレータによって設定されます。アプ リケーションが実行可能な端末記述を見つけるのを助けるためで す。それらのいくつかは正確に適合するものではなく、有名な近 似であり、たとえば "ansi", "vt100", "xterm" などとなってい ます。そのような手法がアプリケーションで問題を起こすことは まれではありません。例えば、ファンクションキーの定義が正し くないなどです。 実行環境で TERM をセットしても、端末エミュレータの動作には 影響がありません。端末内で動作するアプリケーションの実行方 法に影響するのみです。そのうえ、一般的な規則として( xterm はまれな例外ですが)、 TERM をパラメータまたは環境設定として 指定することのできる端末エミュレータは、設定に合わせるため に挙動を変えるということはありません。
ncurses ライブラリが termcap をサポートするように構成され ているとき、 ncurses は terminfo データベースが使えない場合 に termcap 形式の端末記述を調べます。 環境変数 TERMCAP には(改行を取り除いた)端末記述か、環境変 数 TERM によって示される情報がどこに存在するかを示すファイ ル名が含まれます。設定するとどちらの場合も、この情報の通常 の場所、例えば /etc/termcap 、を無視するよう ncurses に指示 します。
ncurses が端末記述を探すディレクトリを変更します。これはデ ィレクトリのリストを変更する最も単純な方法ですが、唯一の方 法ではありません。完全なディレクトリのリストは下記の順序で す。 o もしあれば、 ncurses が最後に書き込んだディレクトリ が最初に検索されます。 o 環境変数 TERMINFO で指定されたディレクトリ。 o $HOME/.terminfo o 環境変数 TERMINFO_DIRS に列挙されたディレクトリ。 o ncurses ライブラリに名前が設定されコンパイルされて いる一つまたは複数のディレクトリ、すなわち o /usr/local/ncurses/share/ter- minfo:/usr/share/terminfo (環境変数 TERMINFO_DIRS に対応) o /usr/share/terminfo (環境変数 TERMINFO に対応)
端末記述を探すディレクトリのリストを指定します。リストは、 Unix ではコロン(":")で、 OS/2 EMX ではセミコロン(";")で区切 ります。 すべての端末記述は terminfo 形式です。通常これらは、端末名 の最初の文字をサブディレクトリ名とするディレクトリツリーに 格納されています。 ハッシュされたデータベースを持つように構成された ncurses では、このリストの収録項目はそれぞれ対応するデータベース・ ファイルのパスでもありえます。 termcap ファイルの直接読み込みをサポートするように構成され た ncurses では、このリストの収録項目は termcap ファイルの パスかもしれません。
TERMCAP がファイル名を持っていない場合、 ncurses は環境変 数 TERMPATH を調べます。これは、 Unix では空白またはコロン (":")で、 OS/2 EMX ではセミコロン(";")で区切られたファイル 名のリストです。 環境変数 TERMPATH が設定されていない場合、 ncurses は /etc/ termcap, /usr/share/misc/termcap, $HOME/.termcap をこの順序 で調べます。 現在のユーザーがスーパーユーザー(root)であるか、アプリケー ションが setuid もしくは setgid パーミッションを使っている 場合、ライブラリは $HOME 同様、 $TERMINFO, $TERMINFO_DIRS, $TERMPATH を無視するように構成されているかもしれません。
ncurses をビルドする際に使う構成スクリプトのオプションによ り、いくつかの異なる構成が可能です。 ncurses を使うアプリケ ーションの開発者に効果のわかりやすい主なオプションがいくつ かあります。 --disable-overwrite ncurses の標準的なインクルード行は、書式の節で書いた ように、次の形です。 #include <curses.h> ncurses がコンピュータ内の curses のメインの実装でな い場合にファイル名の衝突を避けるためにこのオプションを 使います。 ncurses を上書き禁止でインストールすると、 ヘッダをサブディレクトリに置きます。例えば、 #include <ncurses/curses.h> これはまた、実行ファイルをリンクする際に -lcurses を 使えるようにするシンボリック・リンクを省きます。 --enable-widec 構成スクリプトはライブラリ名を変更し、 ( --disable-overwrite オプションが使われた場合)異なる ディレクトリにヘッダ・ファイルを配置します。すべての ライブラリ名には "w" を付加します。すなわち、 -lncurses の代わりに -lncursesw でリンクします。 (ワイド文字用)拡張関数群を使うため、ワイド文字ライブ ラリに対応してコンパイルする際には _XOPEN_SOURCE_EXTENDED も定義しなくてはなりません。ワイド文字ライブラリ用にイ ンストールされる curses.h ファイルは、ノーマル・ライブ ラリ用のヘッダーと互換性を持つように設計されています。 違いは WINDOW 構造体のサイズだけであり、WINDOW 型への ポインタ以外を必要とするアプリケーションはごくわずかで す。ヘッダーが上書きを許すようにインストールされると、 どちらのライブラリを使っても同じヘッダのセットからアプ リケーションが構築できるように、ワイド文字ライブラリの ヘッダは最後にインストールされなければなりません。 --with-pthread 構成スクリプトはライブラリの名前を変更します。すべて のライブラリ名には( --enable-widec で "w" を付加する前 に) "t" を付加します。 LINES などの広域変数は、読み取り専用のマクロで置き換 えられます。同時に、値を設定する関数が用意されます。こ の規約により、いくつかの(非常に少ない)アプリケーション は変更が必要となるでしょう。 --with-shared --with-normal --with-debug --with-profile 共有ライブラリと通常の(静的)ライブラリは名前のサフィッ クスが異なります。例えば、 libncurses.so と libncurses.a です。デバック用ライブラリとプロファイル用ライブラリ は、それぞれ "_g" と "_p" を元の基本名に付け加えます。 例えば、 libncurses_g.so と libncurses_p.a です。 --with-trace trace 関数は通常、デバッグ用ライブラリ内に常駐してい ますが、共有ライブラリ内に構成すると便利なことがときど きあります。構成スクリプトは、関数が常にデバッグ用ライ ブラリ内にあると仮定するのではなく、関数の存在を調べる 必要があります。
/usr/share/tabset 端末機能データベースの初期化ファイルを含むディレクトリ /usr/share/terminfo 端末機能データベース
ルーチンの詳細な説明は、 terminfo(5) および名前が "curs_" で始まる関連ページを参照してください。 curs_variables(3x)
ncurses ライブラリはオプション(-DUSE_GETCAP)つきでコンパイ ルすることにより、端末設定コードが TERM に対応する terminfo の収録項目を見つけられないときに、旧式の /etc/termcap ファ イルに戻すことができます。これは基本的に termcap コンパイラ 全部を ncurses のスタートアップ・コードに含めることになり、 メモリとスタートアップ時間のコストが非常に高くなるため、こ の機能を使うことは推奨されません。 ncurses ライブラリは、( xterm を含む)ある種の端末でマウス イベントをとらえる追加機能を含んでいます。詳細は curs_mouse(3x) のマニュアル・ページを参照してください。 ncurses ライブラリは、例えば xterm 上で実行中の場合に、ウィ ンドウサイズを変更するイベントに応答する追加機能を含んでいま す。詳細は resizeterm(3x), wresize(3x) のマニュアル・ページ を参照してください。つけ加えると、ライブラリは SIGWINCH ハン ドラとともに構成することもできます。 アプリケーションの設計者がそのアプリケーションの実行中に付 加的なキー・シーケンスを定義できるように、 ncurses ライブラ リは、端末の固定的なファンクションキー機能を拡張しています。 詳細は define_key(3x), key_defined(3x), keyok(3x) のマニュ アル・ページを参照してください。 ncurses ライブラリは、アプリケーションが端末本来の前景色と 背景色に戻せるようにする ISO-6429 SGR 39 と SGR 49 コントロ ールを実装する端末の機能を活用することができます。ユーザー の視点からは、アプリケーションが色を個別に設定し、色のコン トラストをよりよく制御できる背景の上に、カラーのテキストを 表示できます。詳細は default_colors(3x) のマニュアル・ペー ジを参照してください。 ncurses ライブラリは、アプリケーションの出力を端末に接続さ れたプリンタに差し向ける機能を含んでいます。詳細は curs_print(3x) のマニュアル・ページを参照してください。
ncurses ライブラリは、 XSI Curses にベースレベルで適合する よう意図されています。 EXTENDED XSI Curses の機能(色のサポ ートを含む)をサポートしています。 少数のローカルな差異を(それは XSI Curses と ncurses での個 々の呼び出しの違いですが)、ライブラリのマニュアル・ページの 移植性の節で説明しています。 他の実装と異なり、 ncurses ライブラリは WINDOW 構造体への ポインタのようなパラメータがヌルでないかどうかチェックしま す。このような挙動にした主な理由は、プログラマのミスから守 るためです。標準的なインターフェイスは、いくつかのありがち なエラーが検出されたことをライブラリからアプリケーションに 伝える方法を提供していません。この(またはいくつかこれ以外の) 拡張機能に頼ると、逆に curses アプリケーションの移植性に悪 影響を及ぼします。 この実装はほかにもいくつかの拡張機能を含んでいます。 o has_key ルーチンは XPG4 の中にも SVr4 にもありません。 詳細は curs_getch(3x) のマニュアル・ページを参照してく ださい。 o slk_attr ルーチンは XPG4 の中にも SVr4 にもありません。 詳細は curs_slk(3x) のマニュアル・ページを参照してくだ さい。 o マウス・インターフェイスに関連する getmouse, mousemask, ungetmouse, mouseinterval, wenclose ルーチンは XPG4 の中 にも SVr4 にもありません。 詳細は curs_mouse(3x) のマニュ アル・ページを参照してください。 o mcprint ルーチンは過去のあらゆる curses の実装にも含ま れません。 詳細は curs_print(3x) のマニュアル・ページを 参照してください。 o wresize ルーチンは XPG4 の中にも SVr4 にもありません。 詳細は wresize(3x) のマニュアル・ページを参照してくださ い。 o WINDOW 構造体の内部の詳細は、アプリケーション・プログ ラムから隠蔽されています。 is_scrollok などの議論は curs_opaque(3x) を参照してください。 o この実装は、マルチスレッド・アプリケーションの基礎的な サポートをする構成が可能です。 詳細は curs_threads(3x) を参照してください。 o この実装はまた、複数画面の制御能力を向上させる関数群を 提供する構成も可能です。 詳細は curs_sp_funcs(3x) を参照 してください。 歴史的な curses のバージョンでは、UNIX tty driver の delay ビットに対応して、 cr, ind, cub1, ff, tab の機能に埋め込ま れた遅延が発現します。この実装では、すべてのパディングは NUL のバイトを送ることで処理します。この手法はやや重いのですが、 UNIX カーネルへのインターフェイスを相当に狭め、それだけパッ ケージの移植性を向上させています。
ヘッダ・ファイル <curses.h> は自動的にヘッダ・ファイル <stdio.h> と <unctrl.h> を取り込みます。 ncurses プログラムからの標準出力が tty 以外の何かにリダイ レクトされた場合、画面の更新は標準エラーに対して行われます。 これは、明記されていない AT&T System V Release 3 curses の 機能です。
Zeyd M. Ben-Halim, Eric S. Raymond, Thomas E. Dickey. Pavel Curtis による pcurses に基づいています。 ncurses(3x)