curs_termcap(3x) curs_termcap(3x)
PC, UP, BC, ospeed, tgetent, tgetflag, tgetnum, tgetstr,
tgoto, tputs - direct curses interface to the terminfo
capability database
- terminfo 機能データベースへの直接の curses インターフェイス
#include <curses.h>
#include <term.h>
extern char PC;
extern char * UP;
extern char * BC;
extern short ospeed;
int tgetent(char *bp, const char *name);
int tgetflag(char *id);
int tgetnum(char *id);
char *tgetstr(char *id, char **area);
char *tgoto(const char *cap, int col, int row);
int tputs(const char *str, int affcnt, int (*putc)(int));
These routines are included as a conversion aid for pro-
grams that use the termcap library. Their parameters are
the same and the routines are emulated using the terminfo
database. Thus, they can only be used to query the capa-
bilities of entries for which a terminfo entry has been
compiled.
これらのルーチンは termcap ライブラリを使うプログラムが
変換するのを助けるため、ライブラリに含まれています。
これらのルーチンは terminfo データベースを使って
エミュレートされ、引数は (termcap ライブラリと) 同じです。
したがって、それらは terminfo 収録項目 (エントリ) が
コンパイルされている収録項目の機能項目 (ケーパビリティ) を
問い合わせることしかできません。
The tgetent routine loads the entry for name. It returns:
tgetent ルーチンは name に対応する収録項目をロードします。
このルーチンは次の値を返します。
1 on success,
1 成功のとき
0 if there is no such entry (or that it is a generic
type, having too little information for curses ap-
plications to run), and
0 そのような収録項目がない (または、ジェネリック・タイプで
あり、curses アプリケーションを実行するには情報が
少なすぎる)
-1 if the terminfo database could not be found.
-1 terminfo データベースが見つからない
This differs from the termcap library in two ways:
このルーチンは termcap ライブラリと 2 つの点で異なります。
o The emulation ignores the buffer pointer bp. The
termcap library would store a copy of the terminal
description in the area referenced by this pointer.
However, ncurses stores its terminal descriptions
in compiled binary form, which is not the same
thing.
o このエミュレーションはバッファ・ポインタ bp を
無視します。
termcap ライブラリはこのポインタが指す領域に端末記述の
コピーを格納します。
しかし、ncurses は端末記述をコンパイルされた
バイナリ形式で格納し、それは同じものではありません。
o There is a difference in return codes. The termcap
library does not check if the terminal description
is marked with the generic capability, or if the
terminal description has cursor-addressing.
o 戻り値に違いがあります。
termcap ライブラリは端末記述が generic 機能項目で
マークされているかどうか、または端末記述が
カーソル・アドレッシングを持つかどうか、
チェックしません。
The tgetflag routine gets the boolean entry for id, or ze-
ro if it is not available.
tgetflag ルーチンは id に対するブール値収録項目を取得します。
できない場合はゼロです。
The tgetnum routine gets the numeric entry for id, or -1
if it is not available.
tgetnum ルーチンは id に対する数値収録項目を取得します。
できない場合は -1 です。
The tgetstr routine returns the string entry for id, or
zero if it is not available. Use tputs to output the re-
turned string. The area parameter is used as follows:
tgetstr ルーチンは id に対する文字列収録項目を返します。
できない場合はゼロです。
返された文字列を出力するには tputs を使ってください。
引数 area は次のように使われます。
o It is assumed to be the address of a pointer to a
buffer managed by the calling application.
o 呼び出し側のアプリケーションが管理するバッファへの
ポインタのアドレスとみなします。
o However, ncurses checks to ensure that area is not
NULL, and also that the resulting buffer pointer is
not NULL. If either check fails, the area parame-
ter is ignored.
o しかし、ncurses はその area が NULL でないことと、
結果を返すパッファ・ポインタも NULL でないことを
確かめます。
どちらかのチェックに失敗したときは、引数 area は
無視されます。
o If the checks succeed, ncurses also copies the re-
turn value to the buffer pointed to by area, and
the area value will be updated to point past the
null ending this value.
o チェックが成功すると、ncurses は area で指される
バッファへ返す値をコピーし、area の値はこの値の
終端ヌルを通り越した点まで増やされます。
(訳注: *area と思われる)
o The return value itself is an address in the termi-
nal description which is loaded into memory.
o 戻り値そのものはメモリにロードされた端末記述内の
アドレスです。
Only the first two characters of the id parameter of tget-
flag, tgetnum and tgetstr are compared in lookups.
tgetflag, tgetnum, tgetstr の引数 id の最初の 2 文字だけが
検索の際に比較されます。
The tgoto routine instantiates the parameters into the
given capability. The output from this routine is to be
passed to tputs.
tgoto ルーチンは引数から与えられた機能項目のインスタンスを
生成します。
このルーチンからの出力は tputs に渡すものです。
The tputs routine is described on the curs_terminfo(3x)
manual page. It can retrieve capabilities by either term-
cap or terminfo name.
tputs ルーチンは curs_terminfo(3x) マニュアル・ページで
説明しています。
このルーチンは termcap 名によっても terminfo 名によっても
機能項目を検索することができます。
The variables PC, UP and BC are set by tgetent to the ter-
minfo entry's data for pad_char, cursor_up and
backspace_if_not_bs, respectively. UP is not used by
ncurses. PC is used in the tdelay_output function. BC is
used in the tgoto emulation. The variable ospeed is set
by ncurses in a system-specific coding to reflect the ter-
minal speed.
変数 PC, UP, BC はそれぞれ terminfo 収録項目 pad_char,
cursor_up, backspace_if_not_bs のデータとして tgetent が
設定します。
ncurses は UP を使いません。
PC は tdelay_output 関数で使います。
BC は tgoto エミュレーションで使います。
変数 ospeed は端末の速度を反映してシステム固有の
コーディングで ncurses が設定します。
Except where explicitly noted, routines that return an in-
teger return ERR upon failure and OK (SVr4 only specifies
"an integer value other than ERR") upon successful comple-
tion.
特記がない限り、整数を返すルーチンは失敗のとき ERR を、
正常終了のとき OK (SVr4 は「ERR 以外の整数値」としか
指定していません) を返します。
Routines that return pointers return NULL on error.
ポインタを返すルーチンはエラーのとき NULL を返します。
If you call tgetstr to fetch ca or any other parameterized
string, be aware that it will be returned in terminfo no-
tation, not the older and not-quite-compatible termcap no-
tation. This will not cause problems if all you do with
it is call tgoto or tparm, which both expand terminfo-
style strings as terminfo. (The tgoto function, if con-
figured to support termcap, will check if the string is
indeed terminfo-style by looking for "%p" parameters or
"$<..>" delays, and invoke a termcap-style parser if the
string does not appear to be terminfo).
ca その他のパラメータ化された文字列を tgetstr を呼び出して
読み出すなら、旧式で十分な互換性のない termcap の
表記法ではなく、terminfo の表記法で返されることに
注意してください。
ともに terminfo 形式の文字列を terminfo として展開する
tgoto または tparm の呼び出しだけしか行わないならば
問題を引き起こしません。
(tgoto 関数は、もし termcap をサポートするように構成されて
いれば、"%p" パラメータか "$<..>" ディレイを探すことにより、
文字列が実際に terminfo 形式かどうかチェックします。そして
文字列が terminfo のように見えないときは termcap 形式の
パーサ (構文解析ルーチン) を呼び出します。)
Because terminfo conventions for representing padding in
string capabilities differ from termcap's, tputs("50");
will put out a literal "50" rather than busy-waiting for
50 milliseconds. Cope with it.
terminfo が文字列機能項目でパディングを表す仕様が termcap と
異なっているため、tputs("50"); は 50 ミリ秒の処理待ちをせず、
リテラル "50" を出力します。
これにうまく対処してください。
Note that termcap has nothing analogous to terminfo's sgr
string. One consequence of this is that termcap applica-
tions assume me (terminfo sgr0) does not reset the alter-
nate character set. This implementation checks for, and
modifies the data shown to the termcap interface to accom-
modate termcap's limitation in this respect.
termcap には terminfo の sgr 文字列に対応するものがないことに
注意してください。
その結果のひとつとして、termcap アプリケーションは
me (terminfo の sgr0) が代替文字セットをリセットしないものと
仮定します。
この実装は termcap インターフェイスに見せるデータを
チェックし修正して、この点での termcap の制限に適応させます。
The XSI Curses standard, Issue 4 describes these func-
tions. However, they are marked TO BE WITHDRAWN and may
be removed in future versions.
これらの関数は XSI Curses standard, Issue 4 に記載されて
います。
しかし、これらは廃止予定と注記されており、将来の
バージョンでは削除されるかもしれません。
Neither the XSI Curses standard nor the SVr4 man pages
documented the return values of tgetent correctly, though
all three were in fact returned ever since SVr1. In par-
ticular, an omission in the XSI Curses documentation has
been misinterpreted to mean that tgetent returns OK or
ERR. Because the purpose of these functions is to provide
compatibility with the termcap library, that is a defect
in XCurses, Issue 4, Version 2 rather than in ncurses.
XSI Curses standard も SVr4 もマニュアル・ページで
tgetent の戻り値を正しく記述していません。しかし、SVr1 以来
3 つとも実際には値を返していました。
特に XSI Curses documentation の手落ちは、tgetent が
OK または ERR を返すものと誤解していました。
これらの関数の目的は termcap ライブラリとの互換性を
与えることなので、それは ncurses でよりも
XCurses, Issue 4, Version 2 での欠陥となっています。
External variables are provided for support of certain
termcap applications. However, termcap applications' use
of those variables is poorly documented, e.g., not distin-
guishing between input and output. In particular, some
applications are reported to declare and/or modify ospeed.
特定の termcap アプリケーションをサポートするために、
いくつかの外部変数が用意されています。
しかし、termcap アプリケーションによるそれらの変数の使用に
ついてはあまり説明されていません。たとえば、入力と出力を
区別していません。
特に、一部のアプリケーションは ospeed を宣言したり
修正したりすると報告されています。
The comment that only the first two characters of the id
parameter are used escapes many application developers.
The original BSD 4.2 termcap library (and historical
relics thereof) did not require a trailing null NUL on the
parameter name passed to tgetstr, tgetnum and tgetflag.
Some applications assume that the termcap interface does
not require the trailing NUL for the parameter name. Tak-
ing into account these issues:
引数 id の初めの 2 文字だけが使われるという注釈は、多くの
開発者から忘れられています。
オリジナルの BSD 4.2 termcap ライブラリ
(とその歴史的遺物) は tgetstr, tgetnum, tgetflag に渡される
パラメータ名の終端ヌル NUL を必要としませんでした。
いくつかのアプリケーションは、termcap インターフェイスには
パラメータ名に終端 NUL が必要ないとみなしています。
これらの問題を考慮すると、
o As a special case, tgetflag matched against a single-
character identifier provided that was at the end of
the terminal description. You should not rely upon
this behavior in portable programs. This implementa-
tion disallows matches against single-character capa-
bility names.
o 特別な場合として、tgetflag は端末記述の最後にあった
1 文字の識別子と一致しました。
ポータブル・プログラムでこの動作に依存してはいけません。
この実装は 1 文字の機能項目名との一致を許していません。
o This implementation disallows matches by the termcap
interface against extended capability names which are
longer than two characters.
o この実装は termcap インターフェイスの検索による
2 文字より長い拡張機能項目名との一致を許していません。
curses(3x), terminfo(5), term_variables(3x), putc(3).
http://invisible-island.net/ncurses/tctest.html
curs_termcap(3x)