WonX
～ WonderWitch on X ～

あなたは

人目のお客様です．

mmap() を実装しました！(2002/2/4)

カラー対応しました！(2001/1/3)

ワンべぇを FreeBSD 上で WonX を使用してコンパイルすることができました!

WonX は，WonderWitch 用のプログラムを X アプリケーションとしてコンパイルするための，ライブラリです．
WonderWitch 用のプログラムを，FreeBSD や Linux 上で動かすための，エミュレータのようなものです．(正しくは，互換ライブラリと言うべきかな？)

以下の特徴があります．

C言語レベルで互換なので，WonderWitch 用のプログラムをUNIX上でそのままコンパイルできる．(-lwonx でコンパイルする)
UNIX上でデバッガを使用してデバッグできるようになる．(強力!)
キャラクタデータやパレットデータのダンプ機能がある．
不正な引数の値や，パレットやキャラクタを初期化しないで使用するなどを厳しくチェックし，エラーを出力する(ようにする)．厳しくエラーチェックする．
使用できない機能(関数は用意してあるが，まだ実装してなかったり，実装が困難だったりして，中身が空のもの)はたくさんある．徐々に追加していくつもり．
ゲームの画面写真が簡単に撮れる．(デジカメで撮ったり，画像取り込み用のプログラムを使ったりする必要が無くなる) これはわりとべんり．
エミュレータでなくライブラリであり，ソースコード公開しているので，自由にカスタマイズが可能．
描画速度は遅いが，デバッグ目的のためなので，速度を速くすることはあまり考えていない．(それよりも上記のデバッグ性を優先する)
WonderWitch 用のプログラムを，X上で楽しむためのものではない．あくまでデバッグ目的のもの．(そういうポリシーで開発を進める)

以下のものにはまだ対応してません．したがって，例えばサウンド関連の関数を呼び出しても，何も起こりません．(空の関数になっている)

サウンド
割り込みのINT0, INT2, INT4(INT1, INT3, INT5,6,7はサポート済み)

バグ情報やアドバイスがあれば，坂井弘亮まで，どんどんメールください．また，リリース版ができるまでは，アップデートは頻繁に行い，随時公開していきます．

Wonx-a01 のダウンロード(2000/9/26)
Wonx-a02 のダウンロード(2000/9/27)
- テキスト表示関連の関数を実行したときに，(あいかわらず文字は表示されないが) せめてターミナルに文字列を出力するようにした．
- スクリーン２のウインドウ機能を実装した． (未テストです．だれか動作情報をください)
Wonx-a03 のダウンロード(2000/9/28)
- screen2_set_window()の表示範囲を修正．(詳細は添付の HISTORY ファイル参照)
- スプライトの有効/無効を実装した．
- LCDカラーマップ，パレット，キャラクター，スプライトのデータダンプ機能を実装．(README参照．F1～F4キーで，ダンプを出力する)
- 関数呼び出し時の表示メッセージを改良．
Wonx-a04 のダウンロード(2000/9/30)
- XDisplay.c 内の表示ルーチンを改良し，描画を多少高速にした．
- WWLCDPanel のデータの格納方法を変更した．
  (２ピクセルで１バイトだったのを，１ピクセルで１バイトを割り当てるようにした)
  (高速化のためだが，将来のカラー対応(241色？)のことも考えた)
- WonxDisplay_Sync() を追加．get 系の関数内での無駄な描画を減らした．
- スプライトウインドウ機能を実装．(未テストです．だれか動作情報をください)
- 時刻関連の関数を実装．(timer.c)
- スプライトの優先順位を修正．(「番号が若いもののほうが優先」に修正した)
Wonx-a05 のダウンロード(2000/10/3)
- XDisplay_DrawLCDWindow() を修正．無駄な計算をループ外に出した．
- WWDisplay_DrawScreen() を修正．無駄な計算をループ外に出した．
- ホットスポットを調べたら，Xの描画部分(XDisplay.c の XDisplay_DrawLCDWindow()のループ部分)がホットスポットになっていたので，ピクセルごとに配列を作って，描画速度を上げた．
Wonx-a06 のダウンロード(2000/10/4)
- WWDisplay_DrawScreen() のアルゴリズムを大幅に修正．
  たいして高速にならなかった．X サーバの描画がホットスポットになっていると思われるので，描画量を減らす努力が必要．
Wonx-a07 のダウンロード(2000/10/5)
- WWLCDPanel にビットマップデータを２枚持たせ，一度描画したビットマップは描画しないように修正．Xサーバの負荷を減らした．
  (WWLCDPanel関連と，XDisplay.c の XDisplay_DrawLCDWindow() を改良)
  (XDisplay.c の XDisplay_DrawLCDWindow() には，無駄な malloc() があるので，そのうち改良が必要)
- wonx-a05 と wonx-a06 の WWDisplay.c (WWDisplay_DrawScreen()) の両方を試した結果，wonx-a05 のほうが高速だったので，wonx-a05 のほうを使用することにした．
Wonx-b01 のダウンロード(2000/10/9)
- テキスト表示機能の追加．(0～127のASCII文字のみで，漢字は未対応)
- Wonx クラスを作成し，すべてのリソースを Wonx クラスで管理するように変更． (Wonx.x WonxP.h 参照)
- p を押して画面の表示/非表示を切替えたときに，LCDパネルの再描画を行うように改良．
- コンパイルオプションに -Wall を追加．
- disp.c で重複した処理をしている関数の処理部分をまとめた．
Wonx-b02 のダウンロード(2000/11/3)
- 割り込み処理の追加．タイマ割り込みサポート．
  (UNIXTimer, WWInterrupt, WWTimer, WonxSystem 追加)
- 割り込みサポートに合わせて，互換関数を UNIXTimer_Pause(), UNIXTimer_Unpause()でくくった．
- UNIXTimer, WWTimer, WonxSystem のコールバック関数などは，割り込み特有のバグが無いか細かくチェックする必要がある．
  (コールバック関数中で割り込みの設定が変わってしまったり，コールバック関数からコールバック関数が呼ばれたりすることはないかどうかチェックする必要がある)
Wonx-b03 のダウンロード(2000/11/13)
- ヘッダファイルを独自に作成．Wonx のみでコンパイル可能になった．
- libwonx.a のリンク時に Error() 関数がぶつかる可能性があるので， Wonx_Error() に変更した．
- bios_exit() を追加．
- sprite_set_char, sprite_get_char で，パレット番号が８を引いた値で指定されていないバグを修正．
- disp.c の font_set_monodata(), font_set_colordata(), font_get_data(), screen_set_char(), screen_get_char(), sprite_set_data() の引数を void * から適切な型に変更．
- サンプルプログラムと SpeedMac を添付した．
- ドキュメントを追加した．
Wonx-b04 のダウンロード(2000/11/18)
- UNIXTimer.c で，コールバック関数が呼ばれるたびにコールバック関数を設定しなおすように修正．
  (UNIXTimer_ON() 中に signal() を追加)
  (IRIX ではコール毎にコールバック関数がクリアされてしまうことへの対処)
- ualarm() は BSD 依存なので，alarm() を使用するように修正．
- UNIXTimer クラスのインターバル時間の設定の単位をマイクロ秒からミリ秒に変更．
- シリアル通信をサポート．(WonxSerialPort, WWSerialPort, comm.c 参照)
- key.c 中の printf() で，戻り値の表示の際に関数名が表示されていなかったのを修正．
Wonx-b05 のダウンロード(2000/11/23)
- シリアル通信で，標準入力からの入力の \n は \r に変換して渡すように comm.c の comm_input() を修正．([WitchFan 00462] のメール参照)
- 画面外へのテキスト文字の表示時に，エラー終了するのでなく，ワーニングを出して続行するように WWText_PutCharacter() を修正． (ワンべぇへの対応)
- wonx_include/types.h に #define _WONX_ を追加．(WONX依存にしたい部分をソース中でくくりたいときのため)
WonX-1.0 のダウンロード(2000/11/23)
- 正式名称を Wonx から WonX に変更．
- MANUAL ファイルを追加．
- OMAKE.jpn に文章追加．
WonX-1.1 のダウンロード(2000/12/28)
- _asm_*() のダミー関数を追加．
- FP_OFF(), FP_SEG() を，WonderWitch での割り込み設定時のコールバック関数の設定方法にあわせて，適切に変更．(wwterm に合わせた)
- UNIXTimer.c:UNIXTimer_Unpause() で， ((unix_timer->pause == 1) && (unix_timer->interrupt_in_pause == 0)) だったときに unix_timer->pause--; されないバグを修正． (ポーズ中に割り込みがかからなかった場合に，アンポーズされていなかったため，タイマ割り込みが正常に動作していなかった．したがって，VBLANK 割り込みなど，割り込み全般が正常に動作していなかった)
- シリアル受信割り込み，キーボード割り込み追加．(wwterm に対応，動作確認済)
- comm_send_string(), text_put_string(), text_put_substring() 実行時の出力メッセージを修正．
- カーソル表示機能を実装．(WWCursor クラス追加)(点滅はしない．表示のみ)
- palette_get_color() 内で，WWPalette_GetMappedColors() の実行時に透明色が -1として返されることを考慮していなかったために，palette_get_color() の戻り値がおかしな値になっていたバグを修正．
- キャラクタカラーパレット，LCDカラーパレットの初期値を，WonderWitch での初期値と一致させた．
- サンプルとして，wwterm-b05 を追加．(Makefile に wwterm ターゲットを追加)
WonX-2.0 のダウンロード(2001/1/3)
- カラー化対応．カラー関連の関数(キャラクタ関連，パレット関連)を実装．
- GCの管理用に，XColorGC クラスを追加．(XFireworks から流用した)
- カラー化に対応させて，transparent(透過色)の判定処理を WWPalette クラスから WWDisplay クラスに移動した．
- WWLCDPanel の pixel を，unsigned short int * に変更．(カラー対応)
- テキストフォントの格納フォーマットを変更．(WWTextFonts.c)
- テキスト表示で，表示時に WWDisplay_GetForegroundColor(), WWDisplay_GetBackgroundColor() を見てコピーするように修正．(WWText.c) (WWText クラス中で WWCharacter の配列を確保しているのが不要になったので，いずれ削除すること)
- WWDisplay クラスにボーダーカラーのパレット追加．(カラー化に対応)
- カラー化に対応させて，その他もろもろの修正を加えた． (キャラクタデータの格納方法，テキスト表示，ボーダーカラーの処理など)
- display_control(), display_status() で，ボーダーカラーのビットシフトが 7 になっていたバグを修正．(8 に修正)
- while(1){/*none*/} での割り込み待ちループ中にも，F1 などのキー入力を受け付けるように修正．(WonXSystem.c のタイマ割り込みのコールバック関数 WonXTimer_Callback() に，WonXDisplay_PrintData() を追加)
- fcntl_attention.h, filesys.h, indirect.h, oswork.h, process.h を追加． (中身はカラ，もしくは適当なファイルをインクルードするだけ)
- wonx_configure.h で，
```
#ifndef _WONX_winx_configure_h_INCLUDED_
#define _WONX_wonx_configure_h_INCLUDED_
```
  になっていたバグを修正．
WonX-2.1 のダウンロード(2001/1/13)
qkcはこちら (漢字・改行コードの変換に UNIX 版の qkc(qkcc100.zip)が必要です)
- パレットデータのダンプ時に，RGB値もダンプするようにした．データのダンプ部分を一部修正．
- perl スクリプトの行頭を，/usr/bin/perl から /usr/local/bin/perl に変更． (FreeBSD では，日本語 perl は /usr/local/bin に入るので)
- disp.c, libwwc.c の，キャラクタのビットマップデータ読み込み用・取得用関数で，ビットマップデータの型を unsigned char * でなく short int *, long int * などの適切な型に修正した．
  WWCharacter クラスのビットマップを，uchar, ushort, ulong の union とし， WWCharacter_GetPixel() では適切な型でアクセスすることにより，ビットマップデータのエンディアンの依存性を無くした． (i386, SPARC で確認済)
- WWCharacter_GetPixel() の 16PACKED カラーモード時の値の取得方法を修正した． (キャラクタが左右反転表示されていたバグが解消した)
- F11 で10秒間停止，もしくは Ctrl-c もしくは F12 で強制終了， Ctrl-i でアイコン化の追加．(もともとあった機能だったが，忘れてたのを，多少修正して正式サポートにした)
- 表示/非表示の切替えキーを p から F10 に移動．マニュアル修正．
- XDisplay.c:XDisplay_DrawLCDWindow() で，XColorGC_CreateFromRGB() で生成した XColorGC オブジェクトを Destroy() していないので，メモリフローしていたバグを修正．(XColorGC_Destroy(x_color_gc) 追加)
- wonx_include/fcntl.h 追加．内容は，/usr/include/fcntl.h, /usr/include/sys/fcntl.h をインクルードするだけ．
- シリアル出力時のメッセージ(output to serial port : )の書式変更． etc.c:wonx_print_character() 修正．sout2str.pl 修正．
- int2sint.pl, filters.pl, challsrc.sh 追加．sys2wonx.pl 変更．
- wonx_include/types.h の
```
typedef unsigned short WORD;
typedef unsigned long  DWORD;
```
  を
```
typedef unsigned short int WORD;
typedef unsigned long  int DWORD;
```
  に変更．
WonX-2.2 のダウンロード(2002/2/4) (F10キーの役割が変わったので注意してください．詳しくは README 参照)
- mmap() を実装した．具体的には README 参照．
- サービス関数を追加．(デバッグ用の情報をダンプするサービス関数と，画面描画ON/OFF制御用のサービス関数を追加) 具体的には README 参照．
- bios_exit() からオブジェクトのデストラクタが呼ばれるようにして，各オブジェクトに適切な Destroy 関数を追加．オブジェクトの削除が適切に行われるように，終了処理を全般的にチェックした．
- key_wait() 中にも割り込みを受け付けるように修正． (以前はキー入力しか受け付けていなかった)
- タイマ割り込みを一部改良．(UNIXTimer.c)
- wonx_include ディレクトリを wonx に名前を変更．
- perl へのフルパスを自動で検索して perl スクリプトの先頭に挿入するように変更．
- Makefile 見直し，改良．
- 画面描画の ON/OFF を，表示レベルによって切替えるように変更． (詳しくは README 参照) また，F9 で表示レベルを下げ，F10 で表示レベルを上げるように変更．それにあわせて，描画のON/OFF部分とキー入力イベント処理の一部見直しをした．
- キーの押下時にメッセージを表示するように修正．
- ```
Obj ObjListData_GetPrev(ObjListData data)
Obj ObjListData_GetNext(ObjListData data)
```
  を
```
ObjListData ObjListData_GetPrev(ObjListData data)
ObjListData ObjListData_GetNext(ObjListData data)
```
  に修正．
- Makefile に install, uninstall ターゲットを追加．challsrc.sh 修正．

現在は坂井が一人で製作していますが，ひとりでは細かい点の整合性 (初期化しなかった場合の動作の違いなど．WonderWitch と WonX では微妙に異なっていると思う)を追いきれないのが現状です．
とくにマニュアルに書いてない部分に関しては，WonderWitch ではどのように動作するのか，ひとりではチェックしきれません．情報をお待ち(ていうか期待)しています．
また，テストもなかなか手がまわりません．ゲームなどでまとまったテストをしたいのですが，WonderWitch 関連はソースコード配布しているソフトウエアが少ないため，テスト題材がなかなか手に入りません．
「動いた」「動かなかった」「この関数は使えた」「この関数はバグがある」というような情報でも結構ですので，情報をお持ちのかたは，連絡ください．
ご意見，ご要望なども歓迎します．どしどしお寄せください． (ただし，返事を書くとは限らないし，要望を反映するとも限りませんのでその点はご容赦ください)

WonX の正しい使いかた

その１: grep と組み合わせる

WonX はデバッグ情報をすべて標準出力に出力します．
これらの情報は，grep で引っかけやすいように，すべて，なんらかの文字列を入れてあります．(例: 関数呼出はすべて call という文字列で始まる)

これらの出力を grep で拾うか捨てるかして，デバッグします．
たとえば，WonX を使用して，SpeedMac をコンパイルして，smac という UNIX 用の実行形式を作成したとすれば，

> smac | grep call | grep palette_set_color > smac.log

のようにして実行すれば，palette_set_color() 関数の呼出だけのログを取ることができます．また，

> smac | grep "character\[0\]" > smac.log

のようにして起動して，起動後に F3 を押すことにより，0 番のキャラクターのビットマップデータを得ることができます． (grep しないと，0 ～ 511 までの全部のキャラクタデータが出力されてしまう)

このように，grep を巧みに使ってデバッグを進めます．

その２: WonX でなんでもやろうとしない

WonX はあくまでデバッグ支援用のライブラリ集であり，これだけで開発が行えるものではありません．実装していない関数も，いっぱいあります．

しかし，UNIXの強力なデバッグ環境が使用できるのと，デバッグ用情報を出力してくれるので，開発の初期段階でのデバッグには，非常に有効です．
だから，はじめのうちは WonX を使ってプログラミング＆デバッグして，あるていど仕上ってきたら WonderWitch に移してチューニングしていくのがいいでしょう．
はじめから WonderWitch で書いて，いざ動かそうとしたら動かなくて，それから WonX のほうでデバッグしようとしても，プログラムが WonX では実装していない関数を使用している場合には，面倒なことになるかもしれません．
つまり，プログラムの立ち上げ時には WonX 使って書いて (WonX で実装していないような関数を使用する部分については後回しにして，とりあえず WonX で動くものを作成する)，立ち上がった後には WonderWitch でチューニングしていけばいいと思います．

注意してほしいのは，WonX で最後の最後まで開発していこうとしないことです．

その３: ソースを改造する

作者は，「自分で改造する」ということも，WonXの使いかたのひとつであると考えているので，「改造しやすさ」ということもサポートの範疇であると思っています．やりたいことができない場合には，ソースを直接改造しましょう． (ライセンスはGPLなので，改造は自由です) 有益な修正ならば，改良点を作者までプットバックしましょう．

できるだけ改造しやすいように，ソース自体もシンプルな構成にしてあります．画面描画まわりは，もっとも手を入れるだろう可能性が高いので，高速性よりもわかりやすさを重視して書いてあります．この方針は，今後もおそらく変わりません． (たとえば，画面描画まわりは，変更された部分だけ描画するようにすれば劇的に速くなると思われるが，それによってソースが難解になるようならば，読みやすさのほうを優先する)

メールは kozos(アットマーク)kozos.jp まで

WonX～ WonderWitch on X ～