パッケージ textbox

タイピングゲームを作成するために，textboxというパッケージを利用します．このパッケージは田中が作成したものです（Go言語組み込みのパッケージではありません）．

仕様

パッケージtextboxの仕様は次の通りです．

PACKAGE

package textbox

import "./textbox"

textboxパッケージは，VT100互換のキャラクタ端末上の矩形領域にテキストを表示するライブラリです．TextBoxは，キャラクタ端末上の矩形領域にテキストを表示する抽象データ型です．生成，領域の移動，領域のクリア，領域への文字の挿入，領域への文字列の挿入の機能を持ちます．パッケージには，型TextBoxのほかに，ディスプレー画面全体をクリアする関数，ディスプレー上の位置を指定してカーソルを移動する関数が定義されています．ディスプレー中の位置や，矩形領域中の位置は左上を原点(0,0)とする座標で指定します．1行1カラム目が(0,0)，n行mカラム目が(m-1,n-1)です．

注意：WindowsのコマンドプロンプトはVT100互換ではないので（エスケープシーケンスが使えないので），このパッケージは利用できません．

FUNCTIONS

func Clear()

画面全体をクリアする．

func Move(x int, y int)

ディスプレー上の指定された位置にカーソルを移動する．

y+1行 x+1カラムにカーソルを移動．

x,yはディスプレーの大きさ(W,H)未満でなければならない．（0 ＜= x ＜ W, 0＜= y ＜ H)

TYPES

type TextBox struct {

// contains filtered or unexported fields

}

func New(x, y, w, h int) (tb *TextBox)

ディスプレー上の位置が(x,y)で，大きさがw列h行のTextBoxを生成する．カーソル位置を(0,0)とする．

位置はディスプレーの大きさ未満でなければならない．（0 ＜= x ＜ W, 0＜= y ＜ H)

ディスプレーの大きさ(H,W)内に収まる位置と大きさでなければならない．(0 ＜ w+x ＜=W, 0＜ h+y ＜= H)

func (tb *TextBox) Clear()

テキストボックスをクリアする（空白文字で埋める）．

func (tb *TextBox) Move(x int, y int)

カーソルをテキストボックス内のx列y行へ移動する．

x,yはtbの大きさ(w,h)未満でなければならない．（0 ＜= x ＜ w, 0＜= y ＜ h)

func (tb *TextBox) PutRune(c rune)

カーソル位置に文字c（UTF-8エンコードされたUnicode文字，日本語可）を表示する．

文字の表示に2カラム占める場合は，1カラムだけtbの領域からはみ出ることがある．

カーソルは次のカラムへ移動する．

（行末なら自動的に改行し先頭カラムへ，最終行の行末なら先頭行先頭カラムへ移動する）

func (tb *TextBox) Putc(c byte)

カーソル位置に文字c（ASCII文字）を表示する．

カーソルは次のカラムへ移動する．

（行末なら自動的に改行し先頭カラムへ，最終行の行末なら先頭行先頭カラムへ移動する）

func (tb *TextBox) Puts(s string)

カーソル位置に文字列を表示する（日本語可）．

カーソルは文字列を表示した次のカラムへ移動する．

文字列内では改行されない．（手抜き ^^;）

ソースコード

演習を進めるのに，ソースコードの中身を理解する必要はありません．仕様だけを理解すれば，textboxをインポートして利用できます．パッケージtextboxのソースコードは参考として以下に示します．

/*
textboxパッケージは，VT100互換のキャラクタ端末上の矩形領域にテキストを表示するライブラリです．TextBoxは，キャラクタ端末上の矩形領域にテキストを表示する抽象データ型です．生成，領域の移動，領域のクリア，領域への文字の挿入，領域への文字列の挿入の機能を持ちます．パッケージには，型TextBoxのほかに，ディスプレー画面全体をクリアする関数，ディスプレー上の位置を指定してカーソルを移動する関数が定義されています．ディスプレー中の位置や，矩形領域中の位置は左上を原点(0,0)とする座標で指定します．1行1カラム目が(0,0)，n行mカラム目が(m-1,n-1)です．
*/
package textbox
import "fmt"
const esc = 0x1B
type TextBox struct {
x,y,w,h int // 位置と大きさ
cx,cy int // TextBox中のカーソルの位置
}
// ディスプレー上の位置が(x,y)で，大きさがw列h行のTextBoxを生成する．カーソル位置を(0,0)とする．
// 位置はディスプレーの大きさ未満でなければならない．（0 ＜= x ＜ W, 0＜= y ＜ H)
// ディスプレーの大きさ(H,W)内に収まる位置と大きさでなければならない． (0 ＜ w+x ＜=W, 0＜ h+y ＜= H)
func New(x, y, w, h int) (tb* TextBox) {
tb = &TextBox{x,y,w,h,0,0}
return
}
// カーソルをテキストボックス内のx列y行へ移動する．
// x,yはtbの大きさ(w,h)未満でなければならない．（0 ＜= x ＜ W, 0＜= y ＜ H)
func (tb *TextBox) Move(x int, y int) {
tb.cx = x
tb.cy = y
fmt.Printf("%c[%d;%dH", esc, tb.y+tb.cy+1, tb.x+tb.cx+1)
}
// テキストボックスをクリアする（空白文字で埋める）．
// カーソルは(0,0)に移動する．
func (tb *TextBox) Clear() {
s := make([]byte,tb.w)
for i:=0; i< tb.w; i++ {
s[i] = ' '
}
for i:=0; i < tb.h; i++ {
fmt.Printf("%c[%d;%df%s", esc, tb.y+i+1, tb.x+1, string(s))
}
tb.Move(0,0)
}
// カーソル位置に文字c（ASCII文字）を表示する．
// カーソルは次のカラムへ移動する
// 行末なら自動的に改行し先頭カラムへ移動する．
// 最終行の行末なら先頭行先頭カラムへ移動する．
func (tb *TextBox) Putc(c byte) {
fmt.Printf("%c[%d;%df%c", esc, tb.y+tb.cy+1, tb.x+tb.cx+1, c)
tb.Move((tb.cx+1)%tb.w,(tb.cy+(tb.cx+1)/tb.w)%tb.h)
Move(0,999) // カーソルを目立たない位置へ
}
// カーソル位置に文字c（UTF-8エンコードされたUnicode文字，日本語可）を表示する．
// 文字が2カラム占める場合は，1カラムだけtbの領域からはみ出る．
// カーソルは次のカラムへ移動する．
func (tb *TextBox) PutRune(c rune) {
fmt.Printf("%c[%d;%df%c", esc, tb.y+tb.cy+1, tb.x+tb.cx+1, c)
col := 1
if c > 0x7F {col = 2} // ASCIIコードより大きなコードは2カラム占めるとしている（手抜きです^^;）
tb.Move((tb.cx+col)%tb.w,(tb.cy+(tb.cx+col)/tb.w)%tb.h)
Move(0,999) // カーソルを目立たない位置へ
}
// カーソル位置に文字列を表示する（日本語可）．
// カーソルは文字列を表示した次のカラムへ移動する．
// 文字列内では改行されない．（手抜き ^^;）
func (tb *TextBox) Puts(s string) {
fmt.Printf("%c[%d;%df%s", esc, tb.y+tb.cy+1, tb.x+tb.cx+1, s)
col := 0
for _,e := range []rune(s) {
if e > 0x7F {col += 2} else {col++}
}
tb.Move((tb.cx+col)%tb.w,(tb.cy+(tb.cx+col)/tb.w)%tb.h)
Move(0,999) // カーソルを目立たない位置へ
}
// ディスプレー上の指定された位置にカーソルを移動する．
// y+1行 x+1カラムにカーソルを移動．
// x,yはディスプレーの大きさ(W,H)未満でなければならない．（0 ＜= x ＜ W, 0＜= y ＜ H)
func Move(x int, y int) {
fmt.Printf("%c[%d;%dH", esc, y+1, x+1)
}
// 画面全体をクリアする．
func Clear() {
fmt.Printf("%c[2J", esc)
}

解説

VT100エスケープシーケンスの利用

textboxパッケージはVT100互換の端末エミュレータ上で実行されることを想定しています．カーソル移動と画面のクリアにVT100のエスケープシーケンスを利用しています．x行yカラムにカーソルを移動するエスケープシーケンスは ESC[x;yH] （81行目など）, 画面をクリアするエスケープシーケンスは ESC[2J （86行目）です．

スライス

スライスは配列をラップした参照型です．配列を扱うGo言語のプログラムでは，配列そのままではなくスライスが多用されます．
スライスは参照型なので，別のスライスに代入したときは，双方が同じ配列を参照します．たとえば関数がスライスを引数として取るとき，関数内でスライスの要素に変更を加えると，ポインタ渡しのように関数の呼び元からも変更内容が参照できます．
スライスは，組込み関数makeで，型と大きさ（と容量）を指定して生成します．33行目では，s:=make([]byte,tb.w)によって，byte型の要素をもつ長さがtb.wのスライスを生成してsに代入しています．要素へのアクセスは配列と同様にs[i]とすることで i 番目の要素のアクセスすることができます．
スライスに関する詳細は言語仕様のスライス型，スライスを参照してください．
文字列は，byteのスライスまたはruneのスライスに変換できます．文字列の値を []byte型へ変換することで，文字列のバイトデータを要素として持つスライスが得られます．また，文字列の値を[]rune型へ変換することで，文字列の各Unicodeコードポイントを持つスライスが得られます．70行目では， []rune(s) によって文字列 s をruneのスライスに変換しています．
変換に関する詳細は言語仕様を参照してください．

Go言語では，C++と同様に/* */ブロックコメント，および//行コメントが使用できます．
基本は行コメントです．
ブロックコメントはパッケージコメント（1行目～3行目）として使われたり，コードをブロック単位で無効化するのに役立ちます．

godoc

go言語には，godocというツール（Webサーバ機能ももつ）があります．
godocは，Go言語のソースファイルから，そのパッケージに関するドキュメントを抽出します．
宣言の前に空行を挟まずに記述されているコメントが，その宣言の説明となります．また，パッケージ文の前に置かれたコメント（パッケージコメント）がパッケージの説明となります．
上記の仕様は，上記のソースコードからgodocで抽出したドキュメントです．