Merge branch 'release_v1_22'

.gitmodules

@@ -1,3 +1,3 @@
 [submodule "cppformat"]
-	path = cppformat
+	path = src/cppformat
 	url = https://github.com/cppformat/cppformat

README.md

@@ -1,281 +1,70 @@
 # knowbug
-* version: 1.21
+* version: 1.22
 
 ## 概要
 HSP3 用デバッグ・ウィンドウの非公式改造版です。
 
+![スクリーンショット](./package/screenshot/static_variables.png)
+
 主に「変数」タブの機能を拡張しており、以下のものの表示に対応しています。
 
-* int の16進数併記
-* 多次元配列の2次元目以降
-* モジュール変数の中身
+* int の16進数表現の併記
+* 多次元配列の2次元全要素
+* モジュール変数のメンバ変数
 * 実行中のユーザ定義コマンドの実引数
 
-![スクリーンショット](./package/screenshot/static_variables.png)
+**[機能の詳細はこちらを参照](details.md)**してください。
 
 ## 導入方法
 #### knowbug 本体
 0. [最新版のパッケージ](https://github.com/vain0/knowbug/releases/latest) の `knowbug-package.zip` をダウンロードします。
 0. HSPのフォルダにある「hsp3debug.dll」の名前を変更します。
 0. [package フォルダ](./package)にある「hsp3debug_knowbug.dll」の名前を「hsp3debug.dll」に変えて、HSPのフォルダに移動します。
 
-* 「HSPのフォルダ」とは、 HSPがインストールされているフォルダで、通常は「C:/Program Files/hsp34」となります。何にせよ「hsp3debug.dll」をみつけてください。
-* 64bit版を使うには、さらに「hsp3debug_64_knowbug.dll」も「hsp3debug_64.dll」という名前にしてHSPのフォルダに移動します。
+* 「HSPのフォルダ」の正確な位置は、HSPスクリプトエディタで ``mes dir_exe`` を実行すると分かります。
+* 64bit版を使うには、「hsp3debug_64_knowbug.dll」も「hsp3debug_64.dll」という名前にして、HSPのフォルダに移動します。
 
 #### WrapCall
 0. 同梱されている「WrapCall.as」と「userdef.as」を common フォルダに移動します。
   * 既に userdef.as を使っている方は、上書きではなく追記してください。
 
-* WrapCall はユーザ定義コマンドに関する機能に使います。無くても正常に動作します。
-* WrapCall は hgimg3 などの拡張ランタイムと併用することができません。拡張ランタイムを使用する場合は、WrapCall.as を \#include しないようにお願いします。
+* WrapCall はユーザ定義コマンドに関する機能に用いられます。無くても正常に動作します。
 * 64bit版ランタイムを使う際は、標準のヘッダ ``hsp3_64.as`` を WrapCall より前に \#include しておく必要があります。
 
 #### 設定ファイル
-[ini ファイル](./package/knowbug.ini) を knowbug (hsp3debug.dll) と同じフォルダに置いておくと、起動時に読み込まれます。
+[設定ファイル](./package/knowbug.ini) を knowbug (hsp3debug.dll) と同じフォルダに置いておくと、起動時に読み込まれます。
 
 * 具体的な設定については、設定ファイル内のコメントを参照してください。
 * 無くても正常に動作します。
 
 ## 除去方法
-「導入方法」と逆の操作をします。なおレジストリなどに記録は残していません。
+「導入方法」と逆の操作をします。なおレジストリなどにデータは残りません。
 
 0. knowbug (ファイル名 hsp3debug.dll) を削除し、バックアップしておいた、元々の
 hsp3debug.dll を、元に戻します。
 0. 「knowbug.ini」「WrapCall.as」は不要なので削除します。
 
-## 機能詳細
-本家版とはインターフェースが異なり、2つのウィンドウがあります。ツリービューは変数のリストの代替であり、そこで選択されるノードに関する情報が、もう一つの灰色メッセージウィンドウに表示されます。
-
-#### ツリービュー
-ツリービューには、すべての静的変数をモジュールごとに分類して並べています。この項目を選択すると、下のボックスに変数の内容 (変数情報) が表示されます。
-
-#### 静的変数
-* 変数名:
-  * 変数の名前です。
-  * モジュールの中にある変数も、完全な名前 (@ を含む) で表示します。
-* 変数型:
-   * 変数の型を次の形式で表します。
-     * ``<vt><tq> <index>``
-   * `<vt>` は変数の型の名前です。
-   * `<tq>` は変数のモードを表します。通常は空("")です。
-     * 変数がクローン変数のとき「&」と表示されます。
-     * 変数が無効な状態のとき、「!」と表示されます。
-   *  `<index>` は配列の形を表します。
-     * 1次元配列の場合、「(x)」です。(x はその要素数)
-     * 2次元配列の場合、「(x, y) (N in total)」と表示されます。
-       * x, y はそれぞれ1,2次元目の要素数で、N は配列全体の要素数です。
-     * 3,4次元配列の場合は、2次元配列と同様です。
-   * 表示例: 「int (2, 3) (6 in total)」
-* アドレス:
-  * 2つの8桁の16進数で表します。
-    0. 変数の実体データがあるメモリのアドレス (PVal::pt)
-    0. 変数のマスターデータがあるメモリのアドレス (PVal::master)
-  * 設定ファイルで非表示にできます。
-* サイズ:
-  * ``X / Y [byte]`` の形式で表します。
-  * X は実体データのサイズを、Y はバッファのサイズを表します。(どちらもバイト単位)
-  * 設定ファイルで非表示にできます。
-
-変数がもつデータは、ツリー形式の文字列で表されます。基本的に本家と同じですが、配列やインスタンス(モジュール型変数の値)は、以下のように表示します:
-```
-	(単体: 一次元一要素)
-	要素名 = 値
-
-	(一次元配列)
-	要素名:
-		.type = 型名[&] (要素数)
-		要素リスト
-
-	(多次元配列)
-	要素名:
-		.type = 型名[&] (要素数(1), ...) (全要素数 in total)
-		要素リスト
-
-	(インスタンス)
-	要素名:
-		.modcls = モジュール名[&]
-		要素リスト
-```
-* 記号「&」は参照(何かを指し示すもの)を表していると思ってください。
-  * 配列変数の型名についている「&」は、その変数がクローン変数であることを示します。クローン変数とは、dup, dupper 命令で作成されるものです。
-  * インスタンスのモジュール名の後についている「&」は、そのインスタンスが他のインスタンスへの弱参照であることを示します。弱参照とは、モジュール変数の値を他の変数に「代入」したときに作成されるあれです。
-
-#### モジュール
-モジュール名のノード(「@...」)自体を選択すると、そのモジュールが持つすべての
-静的変数の値を、簡単に表示します。
-```
-	(モジュール)
-	[@モジュール名]
-	変数名	= 値
-	...
-```
-![スクリーンショット](./package/screenshot/module_overview.png)
-
-#### システム変数
-ルートに位置する「+sysvar」ノードの直下には、システム変数の項があります。
-
-* cnt:
-  * cnt は配列のように表示されます。第一項に相当するものが一番外側のループの cnt で、最後の値、 looplev 番目が現在の cnt の値になります。
-  * repeat ループが実行中でないときは、「(out_of_loop)」と表示されます。
-  * メモリダンプ範囲は HSPCTX::mem_loop[1～looplev] となっています。
-```
-(例)
-	cnt:
-		#(looplev) = (現在のcntの値)
-		#(looplev-1) = 0
-		...
-		#1 = 0
-	なお n = looplev となります。
-```
-
-* notebuf:
-  * 「notebuf」はシステム変数ではありませんが、最後に notesel 命令で指定された (まだ notensel されていない) バッファを表示します。
-
-「+sysvar」ノード自体を選択すると、システム変数の一覧が表示されます。
-
-#### 呼び出し
-WrapCall 対応版を使用している場合、「+dynamic」ノードが存在します。この直下には、呼び出されているユーザ定義コマンドを表すノードが実行に合わせて追加されます。
-
-![スクリーンショット](./package/screenshot/arguments.png)
-
-呼び出しを表すノードを選択すると、以下の形式で、その実引数を表示します:
-```
-	関数名: 命令または関数の名前
-	仮引数: (仮引数タイプ, ...)
-
-	関数名:
-		(0) = 第一引数の値
-		(1) = 第ニ引数の値
-		...
-```
-「(N)」は、N番目の仮引数を表します。HSPのバージョンが新しければ、代わりに仮引数(エイリアス)の名前が表示されます。\#modfunc, \#modcfunc の最初の引数の名前は「thismod」と表示されます。
-
-呼び出しノードは、命令や関数がみつかった時点でツリービューに追加されます。以下の例でいうと、mystmt、myfunc がこの順番でノードに追加されます。
-```hsp
-#module
-#deffunc mystmt var, int
-#defcfunc myfunc int
-#global
-
-	mystmt x, myfunc(0)
-```
-myfunc を実行している間、mystmt の実引数の値は未確定なので、次のように表示されます。
-```
-	mystmt:
-		arguments : (not_available)
-```
-WrapCall では `#modinit`、`#modterm`、または ``\#deffunc onexit`` で定義された関数の呼び出しを検出することができません。これらの実行中かもしれないときは、他の呼び出しの実引数情報を正しく取得できないことがあります。その場合は次のように、値を読み取るのが危険な実引数の値が省略されます。
-```
-	mystmt:
-		x : (unsafe)        //変数の読み取りは危険
-		i = 1               //整数値の読み取りは安全
-```
-
-#### 「ログ」ノード
-logmes 命令で送られてきたログを表示します。
-
-* 「更新」: ログを最新の状態に更新します。
-* 「保存」: ログをファイルに保存します。
-  * (ファイルを指定するダイアログが開きます。)
-  * なお、設定ファイル(knowbug.ini)を用いて、終了時にログを自動で保存するようにできます。
-* 「消去」:
-  * ログをすべて消去します。
-
-* 「自動スクロール」メニュー:
-  * これが付いている間、ログの最後尾まで自動でスクロールします。
-* 「呼び出しを記録」メニュー:
-  * これが付いている間、ユーザ定義コマンドの呼び出しが開始・終了するたびに、そのことがログに出力されます。
-  * WrapCall と接続している場合にのみ有効です。
-
-#### 「スクリプト」ノード
-実行中のスクリプトファイルがみつかった場合は、その内容を表示し、実行している行を自動で選択します。
-
-#### 「全般」ノード
-内容は本家とだいたい同じです (ランタイムから供給されるもの)。
-win32gui版では、カレント・ポジション (pos) とカレント色 (color) も表示します。
-
-### 実行制御
-通常の「実行」「次行」「停止」ボタンの横に、加えて「次飛」「脱出」ボタンが
-追加されています。
-
-* 「実行」(Run):
-  * assert 命令などで停止していた実行を再開します。
-* 「次行」(Step In):
-  * 次の命令を1つ実行して、再び停止します。
-* 「停止」(Stop):
-  * 実行を停止します。
-* 「次飛」(Step Over):
-  * 「次行」と同様に次の命令を実行しますが、それがユーザ定義命令・関数である場合は、その内部の実行が終了してから停止します。
-  * これを押した後、マウスを動かすなどして、デバッグウィンドウにメッセージを送らないと実行位置の表示が更新されません。(既知の不具合)
-```
-(例)
-	// ユーザ定義命令 test1, test2 があるとして
-	assert
-	test1	// ←今ここ！ (assert で停止した)
-	test2
-
-ここで「次飛」を使うと、
-
-	test1	// test1 の実行が完了する
-	test2	// ←今ここ！ (test2 の実行直前で停止する)
-
-となる。
-```
-* 「脱出」(Step Out):
-  * 次の return まで実行します。
-  * ユーザ定義命令・関数の定義の中で使用すると、その命令が終了するところまで実行します。
-```
-(例)
-	test1
-	mes "hello"
-	stop
-
-	#deffunc test1
-		assert
-		mes "process"	// ←今ここ！ (assert で停止した)
-		a = 1
-		test2
-		return
-
-ここで「脱出」を使うと、
-
-	test1			// test1 の実行が完了する
-	mes "hello"		// ←今ここ！
-
-となる。
-```
-
 ## 動作環境
 * HSP3.5 以降
 * OS: Windows 7
 
 これら以外では、動作を確認していません。サポートできない可能性も高いのでご了承ください。
 
-## 既知の不具合
-#### 原因不明なもの
-* 条件付きステップ実行(次飛、脱出)が、knowbug ウィンドウに WindowMessage を送らないと動かない。
-  * wingui ランタイム内の GetMessage, MsgWaitForMultipleObjects で止まっている。
-* ソース小窓の更新時にときどき、ポーンと音が鳴り、新しい行のソースが(上書きではなく)追記される。
-
-#### 対処不能なもの
-* WrapCall と拡張ランタイム(hgimgなど)が併用できない。
-* '@' で始まる名前の静的変数のノードが表示されない。
-
-## 予定と履歴
-[changes.md](./changes.md) を参照してください。
-
 ## 権利
-knowbug は、公式のデバッガ hsp3debug.dll に、uedai が手を加えたものです。
+knowbug は、公式のデバッガ hsp3debug.dll に、ue_dai が手を加えたものです。
 
-本ソフトの半分程度は、[OpenHSP にあるコード、およびリソース](http://dev.onionsoft.net/trac/openhsp/browser/trunk/tools/win32/hsp3debug)を使用しています。[Lisense](http://dev.onionsoft.net/trac/openhsp/browser/trunk/License_j.txt)もご参照ください。
+本ソフトの半分程度は、[OpenHSP にあるコード、およびリソース](http://dev.onionsoft.net/trac/openhsp/browser/trunk/tools/win32/hsp3debug)を使用しています。[ライセンス](./package/License/License_j.txt)も参照してください。
 
 ## 関連URL
-* プログラ広場 <http://prograpark.ninja-web.net/>:
-  * バグ報告、意見、感想、要望などは、ここの[掲示板](http://uedai-kami.bbs.fc2.com/)までお願いします。
+バグ報告、意見、要望などは、[GitHub の Issue 表](https://github.com/vain0/knowbug/issues) または [プログラ広場の掲示板](http://uedai-kami.bbs.fc2.com/) までお願いします。
+
+* knowbug on GitHub <https://github.com/vain0/knowbug/>:
+  * knowbug のソースコードをアップロードしています。
+  * [リリース一覧](https://github.com/vain0/knowbug/releases)
+  * [既知の不具合の一覧](https://github.com/vain0/knowbug/labels/bug)
+
 * HSPTV! <http://hsp.tv/>:
   * HSP3 の公式サイトです。
 * OpenHSP <http://dev.onionsoft.net/trac/>:
   * プロジェクト OpenHSP のリポジトリがあるサイトです。
   * HSPはここで開発されています。
-* knowbug on GitHub <https://github.com/vain0/knowbug/>:
-  * knowbug のソースコードをアップロードしています。

changes.md

@@ -1,10 +1,20 @@
 ## 履歴
+#### 2015/12/05
+* 既定フォントを「MS Gothic」(10)に戻した。
+* エディットコントロールのフォントを ini ファイルで指定できるようにした。
+
+#### 2015/11/15
+* ユーザ定義型の文字列化処理を行う Dll に、VswMethods を能動的に渡すようにした。
+* 組み込み型の文字列化処理も ini で指定できるようにした。
+
 #### 2015/11/08
 * フォントを「IPAGothic」(10pt)に変更した。
 * 変数情報のメモリサイズとバッファサイズの表示書式を微妙に変更した。
 * Fullwidth Colon `：` ではなく、ASCII文字のコロン `:` を使うようにした。
 * "hsp_64.as" が include されていても API 関数の宣言が64ビット版にならないバグを修正した。
   * ``__hsp64__`` ではなく ``__hsp64__@`` が定義済みかどうかをチェックする。
+* リリース (ver: 1.21)
+* インスタンスの文字列化は1回しか行わないようにした。
 
 #### 2015/09/21
 * 「栞」メニューを追加し、「+log」「+script」ノードに移動できるようにした。