For Gauche 0.9.5


Next: , Previous: , Up: ライブラリモジュール - ユーティリティ   [Contents][Index]

12.48 text.console - テキスト端末制御

Module: text.console

このモジュールは文字端末を制御する簡単なインタフェースを提供します。 今のところ、vt100互換端末とWindowsコンソールがサポートされています。

curses等の外部ライブラリには依存しておらず、Gaucheだけで使うことができますが、 出来ることは限られています。 例えばシフトキーだけが押されたタイミングでイベントを受け取ることはできません。 より細かい制御には、何らかの外部拡張ライブラリが必要になるでしょう。

このモジュールの機能の例としては、 Gaucheソースのexamplesディレクトリにあるsnake.scmを見てください。

コンソールオブジェクト

Class: <vt100>

vt100互換端末を表します。このクラスのインスタンスは 以降のジェネリックファンクションの “console” 引数に渡せます。

Instance Variable of <vt100>: iport

端末に接続されている入力ポートです。デフォルトは標準入力です。

Instance Variable of <vt100>: oport

端末に接続されている出力ポートです。デフォルトは標準出力です。

Instance Variable of <vt100>: input-delay

端末は、特殊キーが押された場合、ESCから始まるエスケープシーケンスを送って来ます。 実際にESCキーが押された場合と区別するために、入力の間隔を測っています。 後続の入力がinput-delayμs以内に来なかった場合はそこでシーケンスが終了したと みなし、受け取っているシーケンスが有効なエスケープシーケンスを構成しなければ 個別にキー入力されたとみなします。デフォルトは1000、すなわち1msです。

Class: <windows-console>

Windowsコンソールを表します。このクラス自体は全てのプラットフォームで 定義されていますが、有用なメソッドはWindowsネイティブのランタイムでしか提供されません。

パブリックなスロットはありません。

アプリケーションは実行時にどの種類のコンソールが利用可能かを見極めなければなりません。 推奨される手順は次のとおりです。

次の手続きは上の手順を実装しています。

Function: make-default-console :key if-not-available

実行中のプロセスで使える端末のインスタンスを作成して返します。

適切な端末クラスが無い場合、振る舞いはif-not-availableキーワード引数に 依存します。デフォルトである:errorの場合はエラーが報告されます。 #fの場合はこの手続きが#fを返します。

Function: vt100-compatible? string

環境変数TERMの値を文字列で受け取り、それが<vt100>端末として 扱えるなら#tを、そうでなければ#fを返します。

Console control

Generic function: call-with-console console proc :key mode

Takes over the control of the console, and calls proc with console as the only argument. The console is set to the mode, which must be a symbol with-terminal-mode accepts: raw, rare or cooked. By default the console is set to rare mode, which turn off the echoing and passes most of keystrokes to the program, but it intercepts terminal controls (like Ctrl-C for interrupt and Ctrl-Z for suspend; the actual key depends on terminal settings, though.)

If proc raises an unhandled error, this generic function resets the terminal mode before returning. It does not clear the screen.

Generic function: putch console char

Display a character at the current cursor position, and move the current cursor position.

Generic function: putstr console string

Display a string from the current cursor position, and move the current cursor position.

Generic function: beep console

Ring the beep, or flash the screen (visible bell) if possible.

Generic function: getch console

Fetch a keypress from the console. This blocks until any key is pressed.

The return value may be one of the following values:

A character

A key for the character is pressed. It may be a control code if the control key is pressed with the key; that is, if the user presses Ctrl-A, #\x01 will be returned.

A symbol

Indicates a special key; the following keys are supported: KEY_UP, KEY_DOWN, KEY_LEFT, KEY_RIGHT, KEY_HOME, KEY_END, KEY_INS, KEY_DEL, KEY_PGDN, KEY_PGUP, KEY_F1, KEY_F2, KEY_F3, KEY_F4, KEY_F5, KEY_F6, KEY_F7, KEY_F8, KEY_F9, KEY_F10, KEY_F11, KEY_F12. (Note: DELETE key is usually mapped to #\x7f, but it depends on the terminal).

A list of symbol ALT and a character.

Indicates the character key is pressed with Alt key. For example, if the user presses Alt-a, (ALT #\a) is returned (assuming CAPSLOCK is off).

EOF

Indicates the input is closed somehow.

Modifier keys except ALT are not treated separately but included in the returned keycode. Assuming CAPSLOCK is off, if the user press a, Shift+a, and Ctrl+a, the returned value is #\a, #\A and #\x01, respectively. Ctrl+Shift+a can’t be distinguished from Ctrl+a. ALT+a, ALT+Shift+a, and ALT+Ctrl+a will be (ALT #\a), (ALT #\A) and (ALT #\x01), respectively.

Generic function: chready? console

Returns true if there’s a key sequence to be read in the console’s input.

Generic function: query-cursor-position console

Returns two values, the current cursor’s x and y position. The top-left corner is (0,0).

Generic function: move-cursor-to console row column

Move cursor to the specified position. The top-left corner is (0,0).

Generic function: reset-terminal console

Reset terminal. Usually this sets the character attributes to the default, clears the screen, and moves the cursor to (0, 0).

Generic function: clear-screen console

Clear entire screen.

Generic function: clear-to-eol console

Clear characters from the current cursor position to the end of the line.

Generic function: clear-to-eos console

Clear characters from the current cursor position to the end of the screen.

Generic function: hide-cursor console
Generic function: show-cursor console

Hide/show the cursor.

Generic function: cursor-down/scroll-up console

If the cursor is at the bottom line of the screen, scroll up the contents and clear the bottom line; the cursor stays the same position. If the cursor is not at the bottom line of the screen, move the cursor down.

Generic function: cursor-up/scroll-down console

If the cursor is at the top line of the screen, scroll down the contents and clear the top line; the cursor stays the same position. If the cursor is not at the top line of the screen, move the cursor up.

Generic function: query-screen-size console

Returns two values, the width and height of the screen.

Note: This may affect what’s shown in the console. It is recommended that you only call this before redrawing the entire screen and save the result.

Generic function: set-character-attribute console spec

Set the console so that the subsequent characters will be written with attributes specified by spec.

The character attributes spec is a list in the following format:

(<fgcolor> [<bgcolor> . <option> ...])

where:

<fgcolor> : <color> | #f     ; #f means default
<bgcolor> : <color> | #f
<color>  : black | red | green | yellow | blue | magenta | cyan | white
<option> : bright | reverse | underscore

For example, you can set characters to be written in red with black background and underscore, you can call:

(set-character-attribute con '(red black underscore))

That the options may seem rather limited in the age of full-color bitmap displays. That’s what it used to be, young lads.

Generic function: reset-character-attribute console

Reset character attributes to the default.

Generic function: with-character-attribute console attrs thunk

Sets the console’s attributes to attrs and calls thunk, then restores the attributes. Even if thunk throws an error, attributes are restored.

Note: You should be able to nest this, but currently nesting isn’t working.


Next: , Previous: , Up: ライブラリモジュール - ユーティリティ   [Contents][Index]