# b2c2

BASIC言語風の独自のプログラミング言語(?)のソースコードファイルからCASL2のソースコードファイルを生成する  


 - CASL2/COMET2は「試験で使用する情報技術に関する用語・プログラム言語など」ver2.3の情報を元にしている  
 - 1度に変換できるのは1ファイルのみ。複数のソースファイルがあるときはそれぞれ個別に変換する必要がある  
 - BASICソースコードファイルは1ファイルにつき1つのプログラム(サブルーチン)を 記述する
 - BASICソースコードファイルはUTF-8(BOMなし)で文字エンコードされている必要がある
 - 出力されるCASL2ソースコードはUTF-8(BOMなし)で文字エンコードされる
 - 文字数の埋め込みがある場合はUnicodeスカラ値の個数を文字数として扱う
 - 拡張子`.cas`はCASL2ソースコードとして扱う。それ以外の拡張子はBASICソースコードとして扱う


```
USAGE:
    b2c2 -src <FILE> [OPTIONS]

OPTIONS:
    -dst <DIR>
                        生成されるファイルの出力先ディレクトリを指定する

    -remove-nop
                        生成されるCASL2ソースコードからNOP行を除去しNOPにつけられたラベルを整理する
    -remove-unreferenced-label
                        生成されるCASL2ソースコードから未使用ラベルを除去する
    -remove-comment
                        生成されるCASL2ソースコードからコメント行を除去する
    -try-make-snippets
                        生成されるCASL2ソースコードの重複コードをサブルーチン化することで行数を減らすことを試みる

    -split-subroutines
                        生成されるCASL2プログラムで使用される組み込みサブルーチンを分離し外部プログラムとして出力する

    -program-name <NAME>
                        生成されるCASL2プログラムの名前を指定する

    -statistics
                        生成されるCASL2ソースコードの統計情報ぽいものを出力する

    -run <TARGET>
                        生成されるCASL2プログラムに対してテスト実行もする
                        TARGETにはCASL2/BASIC/NONSTEPのいずれかを指定する
                          CASL2   .. CASL2のコード単位でステップ実行する
                          BASIC   .. BASICのコード単位でステップ実行する (生成されるCASL2プログラムにステップ実行用のコードが挿入されます)
                          NONSTEP .. プログラムの実行だけをします (ステップ数の制限がありません、無限ループのバグがある場合は止まりません)
```


-------------------------------------------------------------------------------

## テスト実行(デバッグモード)

コマンドライン引数で`-run <TARGET>`を追加することでデバッグモードとして起動する  
`<TARGET>`には`CASL2`,`BASIC`,`NONSTEP`のいずれかを指定する  
  
  
`BASIC`を指定した場合、BASICソースファイルに対する`-remove-nop`と`-remove-comment`は変換の都合上のため十分な除去を行わない(ステップ実行のための目印のコードが挿入されるために起きる)    
  
  
`NONSTEP`を指定した場合は生成されるCASL2ソースコードのファイル保存は行われない  
`NONSTEP`を指定した場合は関連するプログラムの自動解決がまず試みられる(CASL2ソースコードが優先的に選択される)  
  
  
`-remove-nop`,`-remove-unreferenced-label`,`-remove-comment`,`-try-make-snippets`,`-split-subroutines`の5つのコマンドライン引数はデバッグモードで読み込まれる全てのBASICソースファイルに適用される


### 共通仕様

 - 基本的には「試験で使用する情報技術に関する用語・プログラム言語など」ver2.3の仕様を考慮
 - メモリサイズは65536語(1語=16ビット)
 - OSの実装はなくメモリ上に相当する領域もない
 - プログラムは番地#0100から配置される
 - SPは番地#FFFFから始まる
 - スタック領域のサイズは8192語
 - 番地#FFFFから8192語の範囲の外にSPがある場合はスタックオーバーフローとして実行停止
 - SVC命令は実行後に全てのGRとFRの値が不定
 - RPUSH,RPOP,IN,OUTはマクロ命令として展開されてメモリに配置される
 - IN命令は`SVC 1`とGR0～GR7の退避復帰命令で構成される
 - OUT命令は`SVC 2`とGR0～GR7の退避復帰命令で構成される
 - PRが番地#FFFE以降を指して実行しようとするとエラーとして実行停止
 - シフト演算で17以上のシフトをした場合は値は0になる
 - 文字定数の全角文字は対応する半角文字があれば半角に変換して処理される
 - 文字定数の全角文字で対応する半角文字が無い場合はUnicodeスカラ値の下位8ビットが配置される
 - チルダはオーバーラインの文字に変換される
 - かな文字はJIS X 0201の半角カナのコードの値としてメモリに配置される
 - OUT命令においてJIS X 0201の半角カナのコードはUnicodeの半角カナの文字として出力される
 - OUT命令において図形文字でも半角スペースでもない文字はUnicodeの\\uFFFDの文字が出力される
 - BASICステップ用の命令は2語で構成され、1語目は#E000、2語目はBASICコードの対応ID



### CASL2デバッグ


#### デバッガコマンド一覧
```
    add-dc <LABEL> <VALUE1>[,<VALUE2>..]
                新しく領域を作り値を格納し先頭アドレスを示すラベルも作る。CASL2のDC相当
                LABEL  .. CASL2のラベル仕様に従う。デバッガで未使用のラベル名を指定する
                VALUE* .. 10進定数、16進定数、文字定数、アドレス定数、リテラルを指定できる

    add-ds <LABEL> <SIZE>
                新しく領域を確保し先頭アドレスを示すラベルを作る。CASL2のDS相当
                LABEL .. CASL2のラベル仕様に従う。デバッガで未使用のラベル名を指定する
                SIZE  .. 確保する領域のサイズ(単位は語)。正の10進数か16進定数で指定する

    copy-mem <ADDRESS_FROM> <ADDRESS_TO> <LENGTH>
                メモリのデータをコピーする
                ADDRESS_FROM .. コピー元の先頭アドレス。16進定数かアドレス定数を指定できる
                ADDRESS_TO   .. コピー先の先頭アドレス。16進定数かアドレス定数を指定できる
                LENGTH       .. コピーするサイズ(単位は語)。正の10進数か16進定数で指定する

    default-cmd [<DEBUG_COMMAND>]
                空行が入力されたときの挙動を設定する
                DEBUG_COMMAND .. デバッガコマンドとその引数を空行入力時のコマンドとして割り当てる
                                 未指定の場合は現在の割り当てコマンドを表示する

    default-cmd none
                空行が入力されたときのコマンド割り当てを解除する

    dump-code [<ADDRESS> [<SIZE>]]
                メモリをコード表示する
                各メモリ位置をCOMET2命令として解釈できる箇所をコード表示していく
                ADDRESS .. 表示対象の先頭アドレス。16進定数かアドレス定数を指定する
                SIZE    .. 表示対象のサイズ(単位は語)。正の10進数か16進定数で指定する

    dump-mem [<ADDRESS> [<SIZE>]]
                メモリダンプする
                各メモリ位置の16進定数表記と8bitごとを文字表記とを表示する
                ADDRESS .. 表示対象の先頭アドレス。16進定数かアドレス定数を指定する
                SIZE    .. 表示対象のサイズ(単位は語)。正の10進数か16進定数で指定する

    fill-mem <ADDRESS> <LENGTH> <VALUE>
                メモリの指定アドレスから指定の長さ分を指定の値で埋める
                ADDRESS  .. 16進定数,アドレス定数
                LENGTH   .. 正の10進数,16進定数
                VALUE    .. 10進定数,16進定数,文字定数(1文字),アドレス定数,リテラル

    find-code <ADDRESS> <COMET2_COMMAND>
                指定のCOMET2コマンドを指定アドレス位置以降から探し最初に見つかったメモリ上のコードを表示する
                ADDRESS        .. 検索開始位置のアドレス。16進定数かアドレス定数で指定
                COMET2_COMMAND .. COMET2のコマンドをCASL2形式で指定する
                                  (アドレス定数にはデバッガの拡張された形式が使用可能)
                例:
                    find-code MAIN LAD GR1,MAIN:FOO,GR2

    find-src <ADDRESS> <CASL2_COMMAND>
                指定のCASL2コマンドを指定アドレス位置以降から探し最初に見つかったコードを表示する
                CASL2ソースまたはBASICから変換されたCASL2ソースから検索する
                ※ソースは整形されている場合がありshow-srcコマンドで確認できる
                ADDRESS        .. 検索開始位置のアドレス。16進定数かアドレス定数で指定
                COMET2_COMMAND .. CASL2のコマンドをソースに記載されている形で指定する
                例:
                    find-src MAIN LAD GR1,FOO,GR2

    find-value <ADDRESS> <VALUE>
                指定の値をメモリの指定アドレス位置から探し最初に見つかった位置を表示する
                ADDRESS .. 検索開始位置のアドレス。16進定数かアドレス定数で指定
                VALUE   .. 検索する値。10進定数、16進定数、文字定数、アドレス定数を指定できる

    help [<COMMAND_NAME>]
                指定デバッガコマンドの詳細ヘルプを表示する
                COMMAND_NAME .. デバッガコマンド名を指定する
                                省略時は全てのコマンドの簡易ヘルプを表示する

    help constant
                デバッガコマンドで使用する定数に関する説明を表示する

    list-files
                読み込んだソースファイルの一覧を表示する
                ソースファイルとラベルの対応を表示する

    mode <MODE>
                指定したデバッグモードに切り替える(BASICデバッグモードで起動した場合にのみ有効)
                MODE .. BASICかCASL2を指定して切り替える

    quit
                テスト実行を中止しデバッガを終了する

    remove-breakpoint [<ADDRESS1>[,<ADDRESS2>..]]
                指定アドレスのブレークポイントを解除する。アドレス省略時はPRの示すアドレス
                ADDRESS* .. 解除対象のアドレス。16進定数かアドレス定数で指定

    reset
                プログラムを最初から実行しなおす。プログラムをファイルから読み込みなおし配置される

    restart
                プログラムを最初の位置から実行しなおす。メモリやGRやFRは終了時点の状態クリアされずに最後の実行状態のまま維持される
                set-startコマンドで指定されている場合はそのプログラムからスタートとなる

    run [<STEP_LIMIT>]
                次のブレークポイントまで実行する。ステップ制限数までにブレークポイントに到達しない場合はそこで停止する
                STEP_LIMIT .. ステップ制限数。正の10進数で指定する(最大値は18446744073709551615)
                              省略した場合は 100000000

    set-breakpoint [<ADDRESS1>[,<ADDRESS2>..]]
                指定アドレスにブレークポイントを設定する。アドレス省略時はPRの示すアドレス
                ADDRESS* .. 解除対象のアドレス。16進定数かアドレス定数で指定

    set-by-file <FILE_PATH>
                ファイルに列挙された設定系のデバッガコマンドを実行する
                1行につき1コマンドを配置できる
                空行は無視される
                ファイルに指定できないデバッガコマンド:
                    quit reset restart run set-by-file skip s step

    set-label <LABEL> <ADDRESS>
                アドレスのエイリアスである新しいラベルを作る。
                LABEL   .. CASL2のラベル仕様に従う。デバッガで未使用のラベル名を指定する
                ADDRESS .. エイリアス対象のアドレス。16進定数かアドレス定数で指定

    set-mem <ADDRESS> <VALUE1>[,<VALUE2>..]
                値をメモリの指定アドレスに書き込む
                値を複数列挙した場合はアドレスから連続した領域に書き込まれる
                値が文字定数の場合は文字数分の連続した領域に書き込まれる
                ADDRESS  .. 16進定数,アドレス定数
                VALUE*   .. 10進定数,16進定数,文字定数,アドレス定数,リテラル

    set-reg <REGISTER> <VALUE>
                値をレジスタに設定する

                REGISTER .. GR0～GR7
                VALUE    .. 10進定数,16進定数,文字定数(1文字),アドレス定数,リテラル

                REGISTER .. OF,SF,ZF
                VALUE    .. 0,1

                REGISTER .. PR,SP
                VALUE    .. 16進定数,アドレス定数

    set-start [<ADDRESS>]
                プログラムの開始点を変更する(restart時に影響)。省略した場合は最初の開始点に戻す
                ADDRESS  .. プログラム開始点のアドレス。16進定数かアドレス定数で指定

    show-labels [<PROGRAM_ENTRY>]
                ラベルの一覧とアドレスを表示する。PROGRAM_ENTRYを指定した場合はローカルラベルを表示する
                PROGRAM_ENTRY .. プログラムエントリラベルを指定

    show-mem <ADDRESS> [<LENGTH>] [<TYPE>]
                メモリの指定アドレスから指定の長さ分の領域の各値を列挙する
                ADDRESS  .. 対象の先頭アドレス。16進定数かアドレス定数で指定
                LENGTH   .. 表示対象のメモリのサイズ(単位は語)。正の10進数か16進定数で指定
                            省略した場合は1語
                TYPE     .. 指定するとBASICの型に合わせた内容表示になる
                            指定できるのはboolean,integer,stringの3種類
                            省略した場合は16進定数として表示される

    show-mem-stat <ADDRESS> [<LENGTH>]
                メモリの指定アドレスから指定の長さ分の領域の統計情報ぽいものを表示する
                表示されるのは書込回数 読込回数 実行回数となる
                        書込回数 .. ST命令やOUT命令で指定されたアドレスに書き込まれた回数
                        読込回数 .. LD命令などで指定されたアドレスから読み込まれた回数
                                   ※アドレス指定で読み込む命令による読み込み全てが対象
                        実行回数 .. PRで指定されたアドレスが実行された回数
                ADDRESS  .. 対象の先頭アドレス。16進定数かアドレス定数で指定
                LENGTH   .. 表示対象のメモリのサイズ(単位は語)。正の10進数か16進定数で指定
                            省略した場合は1語

    show-reg
                各レジスタの現在の値を表示する
                GR0～GR7,PR,SP,FR(ZF,SF,OF)が表示対象。
                GR0～GR7は10進定数と16進定数の2つの表現で表示される
                PR,SPは16進定数として表示される
                ZF,SF,OFはビットとして0または1が表示される

    show-src [<ADDRESS> [<LENGTH>]]
                指定したアドレス位置から指定長さ分の範囲にあるコードを表示する
                CASL2ソースまたはBASICから変換されたCASL2ソースを表示する(※ソースは整形されている場合がある)
                ADDRESS  .. 対象の先頭アドレス。16進定数かアドレス定数で指定
                LENGTH   .. 表示対象のメモリのサイズ(単位は語)。正の10進数か16進定数で指定
                            省略した場合は40語分

    show-state
                直近の実行(run,skip,step)の結果を再表示する
                ※レジスタ情報は表示されない

    show-var [<BASIC_PROGRAM_ENTRY> [<VAR_NAME1>[,<VAR_NAME2>..]]]
                指定したBASICプログラムの変数名と対応するラベルとアドレスと値を表示する
                BASIC_PROGRAM_ENTRY .. BASICソースに指定されているプログラムエントリラベル
                VAR_NAME*           .. BASICソースに含まれる変数名(注意:大文字小文字は区別される)

    skip [<STEP_LIMIT>]
                現在のサブルーチンのRETまで実行する。ステップ制限数までにRETに到達しない場合はそこで停止する
                STEP_LIMIT .. ステップ制限数。正の10進数で指定する(最大値は18446744073709551615)
                              省略した場合は 100000000

    s    [<STEP_COUNT>]
    step [<STEP_COUNT>]
                指定ステップ数だけ実行する。STEP_COUNT省略時は1ステップだけ実行する
                STEP_COUNT .. ステップ数。正の10進数で指定する(最大値は18446744073709551615)
                              省略した場合は 1

    write-code <ADDRESS> <CASL2_COMMAND>
                アドレス位置に指定のCASL2コマンドを書き込む
                ADDRESS       .. 対象の先頭アドレス。16進定数かアドレス定数で指定
                CASL2_COMMAND .. 書き込むCASL2コマンド
                                 アドレス定数にはデバッガの拡張形式が使用可能
                                 IN,OUT,RPUSH,RPOPは展開されて複数の命令が書き込まれる
                                 START,END,DSは指定できない
                例:
                    add-ds FOO 6
                    write-code FOO         LD GR1,MAIN:X
                    write-code FOO+#0002   LD GR2,MAIN:Y
                    write-code FOO+#0004   ADDL GR1,GR2
                    write-code FOO+#0005   RET
```

#### 定数について
```
    10進定数
                -32768　～ 32767

    16進定数
                #0000 ～ #FFFF

    文字定数
                文字・文字列を引用符で囲ったもの(引用符を2つ続けると引用符1文字の文字として扱う)
                    例: 'X'
                        'Abc123'
                        'Let''s go!'

    アドレス定数 (当デバッガの拡張仕様となっている)

        ラベル
                        グローバルラベル (各プログラムのエントリラベル、デバッガコマンドで定義したラベル)
                            例: MAIN

        ラベル:ラベル
                        ローカルラベル (各プログラムの内部のラベル)。 プログラムのエントリラベル:内部ラベル　で表記
                            例: MAIN:I001
                                LIB:MEM

        @レジスタ
                        レジスタ(GR*,PR,SP)の値をアドレスとする
                            例: @GR3
                                @PR

        (アドレス定数)
        (16進定数)
                        アドレス定数または16進定数の示すアドレスから読み込んだ値をアドレスとする
                            例: (MAIN:MEM)
                                (#1234)

        アドレス定数+アドレス定数
        アドレス定数+16進定数
        アドレス定数+10進数
                        2つのアドレス定数または16進定数の和をアドレスとする(オーバーフローに注意)
                            例: MAIN+@GR1
                                (MAIN:MEM)+#0101
                                MAIN:FOO+10

        アドレス定数-アドレス定数
        アドレス定数-16進定数
        アドレス定数-10進数
        16進定数-アドレス定数
                        2つのアドレス定数または16進定数の差をアドレスとする(オーバーフローに注意)
                            例: LIB:S005-LIB:B001
                                MAIN:J004-#0010
                                MAIN:FOO-3
                                #FFFF-@SP

    リテラル
                10進定数、16進定数、文字定数の頭に=を付けて指定
                領域を確保し値を格納の後そのアドレスを返す
                    例: =123
                        =#ABCD
                        ='XYZ'
```




### BASICデバッグ

#### デバッガコマンド一覧
```
    default-cmd [<DEBUG_COMMAND>]
                空行が入力されたときの挙動を設定する
                DEBUG_COMMAND .. デバッガコマンドとその引数を空行入力時のコマンドとして割り当てる
                                 未指定の場合は現在の割り当てコマンドを表示する

    default-cmd none
                空行が入力されたときのコマンド割り当てを解除する

    fill-arr <VAR_NAME> <VALUE>
                現在地点のプログラムの配列変数の全ての要素を指定の値で埋める。値はBASICリテラルのみ
                文字列を指定した場合は文字列のその時点の長さ分だけ埋める
                プログラムが(initialize)に到達してない場合は設定できない
                VAR_NAME .. 固定長配列の変数名または文字列の変数名(注意:大文字小文字は区別される)
                VALUE    .. 配列に対応する型のBASICリテラル値(真理値/整数)

    help [<COMMAND_NAME>]
                指定デバッガコマンドの詳細ヘルプを表示する
                COMMAND_NAME .. デバッガコマンド名を指定する
                                省略時は全てのコマンドの簡易ヘルプを表示する

    list-files
                読み込んだソースファイルの一覧を表示する
                ソースファイルとラベルの対応を表示する

    mode <MODE>
                指定したデバッグモードに切り替える(BASICデバッグモードで起動した場合にのみ有効)
                MODE .. BASICかCASL2を指定して切り替える

    quit
                テスト実行を中止しデバッガを終了する

    remove-breakpoint <BASIC_PROGRAM_ENTRY> <STATEMENT_ID1>[,<STATEMENT_ID2>..]
                指定したBASICプログラムからブレークポイントを解除する
                BASIC_PROGRAM_ENTRY .. BASICソースに指定されているプログラムエントリラベル
                STATEMENT_ID*       .. BASICソースのステートメントID
                                       IDはshow-srcコマンドで確認できる

    reset
                プログラムを最初から実行しなおす。プログラムをファイルから読み込みなおし配置される

    restart
                プログラムを最初の位置から実行しなおす。メモリの状態はクリアされずに最後の実行状態のまま維持される
                set-startコマンドで指定されている場合はそのプログラムからスタートとなる

    run [<BASIC_STEP_LIMIT> [<COMET2_STEP_LIMIT>]]
                次のブレークポイントまで実行する
                BASIC_STEP_LIMIT  .. BASICステートメントのステップ数制限
                                     省略した場合は 100000000
                COMET2_STEP_LIMIT .. COMET2命令のステップ数制限
                                     省略した場合は 1000000000000

    set-breakpoint <BASIC_PROGRAM_ENTRY> <STATEMENT_ID1>[,<STATEMENT_ID2>..]
                指定したBASICプログラムにブレークポイントを設定する
                BASIC_PROGRAM_ENTRY .. BASICソースに指定されているプログラムエントリラベル
                STATEMENT_ID*       .. BASICソースのステートメントID
                                       IDはshow-srcコマンドで確認できる

    set-by-file <FILE_PATH>
                ファイルに列挙された設定系のデバッガコマンドを実行する
                1行につき1コマンドを配置できる
                空行は無視される
                ファイルに指定できないデバッガコマンド:
                    quit reset restart run set-by-file skip s step

    set-elem <VAR_NAME> <INDEX> <VALUE>
                現在地点のプログラムの配列変数の要素に値を設定する。値はBASICリテラルのみ
                プログラムが(initialize)に到達してない場合は設定できない
                VAR_NAME .. 固定長配列の変数名または文字列の変数名(注意:大文字小文字は区別される)
                INDEX    .. 値を設定する配列・文字列の位置。10進数で指定。長さ以上の値は指定できない
                VALUE    .. 配列に対応する型のBASICリテラル値(真理値/整数)

    set-len <STR_VAR_NAME> <LENGTH>
                現在地点のプログラムの文字列変数の長さ情報のみを書き換える
                プログラムが(initialize)に到達してない場合は設定できない
                STR_VAR_NAME .. 文字列の変数名(注意:大文字小文字は区別される)
                LENGTH       .. 文字列の長さ。0以上256以下の10進数で指定

    set-var <VAR_NAME> <VALUE1>[,<VALUE2>..]
                現在地点のプログラムの変数に値を設定する。値はBASICリテラルのみ
                プログラムが(initialize)に到達してない場合は変数に値を設定できない
                プログラムのスタート地点の場合は引数に値の設定が可能(必要に応じてメモリ確保がされる)
                VAR_NAME .. 変数名(注意:大文字小文字は区別される)
                VALUE*   .. 変数に代入する値や文字列。BASICリテラル
                            配列の場合はカンマ区切りで配列長分の値を並べる必要がある

    show-execute-stat [<BASIC_PROGRAM_ENTRY>]
                指定したBASICプログラムのコード実行の統計情報ぽいものを表示する
                各ステートメントの到達回数が表示される
                BASIC_PROGRAM_ENTRY .. BASICソースに指定されているプログラムエントリラベル

    show-src [<BASIC_PROGRAM_ENTRY>]
                指定したBASICプログラムのコードを表示する
                入力されたファイルのソースコードではなく、
                CASL2ソースへ変換後に埋め込まれた情報から復元したコードとなる
                BASIC_PROGRAM_ENTRY .. BASICソースに指定されているプログラムエントリラベル

    show-state
                直近の実行(run,skip,step)の結果を再表示する
                ※変数の情報は表示されない

    show-var [<BASIC_PROGRAM_ENTRY> [<VAR_NAME1>[,<VAR_NAME2>..]]]
                指定したBASICプログラムの変数名を表示する。可能な場合は値も表示する
                値が表示されるのは実行状態で(initialize)に到達しているプログラムが対象となる
                BASIC_PROGRAM_ENTRY .. BASICソースに指定されているプログラムエントリラベル
                VAR_NAME* .. 対象プログラムの変数名(注意:大文字小文字は区別される)

    skip [<BASIC_STEP_LIMIT> [<COMET2_STEP_LIMIT>]]
                現在地点のサブルーチンを抜けるまで実行する
                BASIC_STEP_LIMIT  .. BASICステートメントのステップ数制限
                                     省略した場合は 100000000
                COMET2_STEP_LIMIT .. COMET2命令のステップ数制限
                                     省略した場合は 1000000000000

    s    [<BASIC_STEP_COUNT> [<COMET2_STEP_LIMIT>]]
    step [<BASIC_STEP_COUNT> [<COMET2_STEP_LIMIT>]]
                指定ステップ数だけ実行する。BASIC_STEP_COUNT省略時は1ステップだけ実行する
                BASIC_STEP_COUNT  .. BASICステートメントを実行するステップ数
                                     省略した場合は 1
                COMET2_STEP_LIMIT .. COMET2命令のステップ数制限
                                     省略した場合は 1000000000000
```