• Gauche で、スクリプトのデバッグを行うためのモジュールです。
  現状、制限事項がいろいろと存在します。

• gsdbg.scm を Gauche でロード可能なフォルダにコピーします。
  (例えば (gauche-site-library-directory) で表示されるフォルダ等)

• スクリプトファイル内で (use gsdbg) によりモジュールを読み込み、
  デバッガを起動したい箇所に gsdbg 手続きを記述してください。
  gsdbg 手続きの書式は以下の通りです。

  • (gsdbg [:pa prompt-add] [:lv local-vars] [:rv ret-val])
    デバッガを起動します。

    • キーワード引数 :pa の prompt-add には、プロンプトに追加で表示する文字列を指定します。
      (デバッガを起動した位置が分かるような文字列を指定することを想定しています)
      このキーワード引数に #f を指定すると、プロンプトに文字列を追加しません。
      このキーワード引数を指定しなかった場合には、#f を指定したことになります。

    • キーワード引数 :lv の local-vars には、ローカル変数の名前を、
      (name1 name2 ...) のようなリストで指定します (リストのクォートは不要です)。
      現状、デバッガは、ローカル環境を認識することができません。
      このため、デバッガ内でローカル変数にアクセスしたい場合には、
      本引数で明示的に指定する必要があります。
      本引数で指定したローカル変数の内容は、後述の ,locvar コマンドで表示可能です。
      また、後述の getlv / setlv 手続きで参照と更新が可能です。
      このキーワード引数に #f を指定すると、ローカル変数の指定なしになります。
      このキーワード引数を指定しなかった場合には、#f を指定したことになります。

    • キーワード引数 :rv の ret-val には、デバッガの戻り値を指定します。
      このキーワード引数を指定しなかった場合には、#f を指定したことになります。
      (現状、多値を返すことはできません)

    • ＜例1＞

      (use gsdbg)
      (let ((x 100) (y 200))
        (gsdbg :pa "test1" :lv (x y)))
      

      デバッガを起動し、
      プロンプトに "test1" という文字列を追加し、また、
      ローカル変数の x と y を ,locvar コマンドで表示可能にする例です。

    • ＜例2＞

      (use gsdbg)
      (guard (e (else (report-error e) (gsdbg :pa "err1")))
        (/ 1 0))
      

      エラー発生時にデバッガを起動する例です。

• デバッガ内では、以下のコマンドが使用可能です。
  (これらは、Gauche の REPL の トップレベルコマンド として登録されており、
  各コマンドは、カンマ記号で始まります (括弧の入力は不要です))
  (トップレベルコマンドのヘルプは ,h で確認できます)

  • ,continue または ,c
    デバッガを終了し、スクリプトの実行を再開します。

  • ,go
    デバッガを終了し、スクリプトの実行を再開します。
    ただし、これ以後、gsdbg 手続きがあっても、デバッガを起動しません。

  • ,quit [code]
    終了コードを code としてスクリプトを終了します (本当に終了するか、確認を求められます)。
    引数を省略した場合には、終了コードを 0 としてスクリプトを終了します。

  • ,backtrace または ,bt
    バックトレースを表示します。

  • ,curmod または ,cm
    現在選択中のモジュール (カレントモジュール) の名前を表示します。

  • ,selmod [module] または ,sm [module]
    現在選択中のモジュール (カレントモジュール) を切り換えます。
    引数には、モジュール名を指定します。
    引数を省略した場合には、user モジュールが選択されます。
    (モジュールの内部のグローバル変数の内容を参照/更新したい場合には、
    本コマンドで、モジュールを切り換えてください)

  • ,locvar [name1 name2 ...] または ,lv [name1 name2 ...]
    ローカル変数を表示します。引数には、ローカル変数名を指定します。
    複数の引数を指定すると、複数のローカル変数を表示します。
    ローカル変数は、gsdbg 手続きの local-vars で指定したもののみ指定可能です。
    引数を省略した場合には、指定可能なすべてのローカル変数が表示されます。
    (変数の値のみを取り出したい場合には、後述の getlv 手続きを使用してください)

  • ,retval [value] または ,rv [value]
    デバッガの戻り値を設定します。
    引数を省略した場合には、現在の設定内容を表示します。
    (現状、多値を返すことはできません)

• ＜その他の手続き＞
  その他、本モジュールには以下の手続きが存在します。

  • (gsdbg-on)
    gsdbg 手続きで、デバッガを起動するようにします (デフォルトの動作)。

  • (gsdbg-off)
    gsdbg 手続きで、デバッガを起動しないようにします。
    (ただし、gsdbg 手続きが完全に消える訳ではありません)

  • (getlv name)
    デバッガが認識しているローカル変数の値を取得します。
    引数には、ローカル変数の名前を指定してください。
    ローカル変数は、gsdbg 手続きの :lv キーワード引数で指定したもののみ指定可能です。

  • (setlv name value)
    デバッガが認識しているローカル変数の値を設定します。
    (厳密には、デバッガの終了時に設定されます)
    引数には、ローカル変数の名前と新しい値を指定してください。
    ローカル変数は、gsdbg 手続きの :lv キーワード引数で指定したもののみ指定可能です。

  • (retval value)
    デバッガの戻り値を設定します。
    引数を省略した場合には、現在の設定内容を表示します。
    (現状、多値を返すことはできません)

• 現状、以下の制限事項が存在します。
  • デバッガを起動するために、スクリプト内に gsdbg 手続きを記述する必要がある
    (gsdbg は、戻り値がある手続きであるため、
    挿入場所によっては、スクリプトの実行結果が変わってしまう)
  • 動的にブレークポイントを設定できない
  • ステップ実行ができない
  • ローカル環境が見られない
    → 暫定対策として、gsdbg 手続きの引数に、ローカル変数のリストを渡せるようにした
  • マルチスレッド非対応

1. 本モジュールは、標準の gauche.interactive.toplevel モジュールの内部情報を使用し、
   また、一部処理を上書きします。
   このため、Gauche の将来の変更で動作しなくなる可能性があります。

• OS
  • Windows 8.1 (64bit)
• 言語
  • Gauche v0.9.9
  • Gauche v0.9.8
  • Gauche v0.9.7

• 2019-5-6 v1.00 (初版)
• 2019-5-7 v1.01 コメント変更等
• 2019-5-8 v1.02 getlvの処理見直し
• 2019-10-30 v1.03 モジュールの選択は、デバッガ終了時に元に戻すようにした
• 2019-10-31 v1.04 v1.03の変更を元に戻した。,curmodコマンドを追加
• 2019-10-31 v1.05 ,retコマンドの引数を省略した場合には、現在の設定内容を表示するようにした
• 2019-10-31 v1.06 ローカル変数の表示を修正
• 2019-10-31 v1.07 gsdbg手続きにデバッガの戻り値の引数を追加(省略可)
  ,quitコマンドに終了コードの引数を追加(省略可)
  ,retコマンドの処理を修正
• 2019-11-1 v1.08 ,retコマンドの表示処理を修正
  ,curmodコマンドが,carmodになっていたのを修正
  ,quitコマンドの処理見直し
• 2019-11-1 v1.09 ,locvarコマンドのエラーチェック追加
• 2019-11-1 v1.10 gsdbg手続きの戻り値の処理見直し
• 2019-11-3 v1.11 ,retコマンドを,retval(または,rv)コマンドに名称変更(過去との互換性なし)
• 2020-3-20 v2.00 gsdbg手続きの引数をキーワード引数に変更(過去との互換性なし)
  setlv,retval手続きを追加
• 2020-3-20 v2.01 gsdbg手続きの :lv キーワード引数の処理を一部修正
• 2020-3-20 v2.02 ,quitコマンドの終了確認処理を追加
• 2020-3-20 v2.03 setlvのvalue引数が2回評価されていた件の修正等
• 2020-3-20 v2.04 ,continueと,goコマンドは、デバッガ実行中のみ処理するように変更
• 2020-3-22 v2.05 エラーチェック追加。一部処理見直し等

(2020-3-22)