digital-sound-antiques / mgsc Goto Github PK

mgsc はコンソール上で動作する MGSコンパイラ です。MML を記述したテキストファイルから、MGSDRV形式の音楽データ(.mgs)を生成します。

mgsc は C++ で実装されていますが、スクラッチで作られたコンパイラではなく、CP/M エミュレータ上で MSX 用のMGSC.COMバイナリを直接動作させています。 このため、MSX 版MGSC.COMの振る舞いがほぼ完全に再現されています。

MML の文法についてはMSX 版MGSC.COMのMMLドキュメントを参照してください。

gitとcmakeが必要です。

以下の手順を実行すると mgsc バイナリをビルドできます。

$ git clone --recursive https://github.com/digital-sound-antiques/mgsc.git
$ cd mgsc
$ cmake .
$ make

Visual Studio 2015とgitとcmakeがインストールされている環境が必要です。

Visual Studio は、一度も C++ プロジェクトを作ったことがない場合、C++ がインストールされていません。 その場合は C++ プロジェクトを新規作成して C++ をインストールしておいてください。

gitのbashコンソールから以下の手順を実行します。

$ git clone --recursive https://github.com/digital-sound-antiques/mgsc.git
$ cd mgsc
$ cmake .

以上で Project.sln が生成されるので、Visual Studio で開いてビルドします。

$ mgsc MMLファイル名 [出力ファイル名] [オプション]

出力ファイル名、オプションは省略可能です。出力ファイル名が省略された場合、出力ファイル名は MML ファイルの拡張子をmgsに変更したものになります。 出力ファイル名、入力ファイル名共にパスを含む事が可能です。パス指定が無い場合は、カレントフォルダに対して入出力が行われます。

mgsc の起動後、入力ファイルにエラーが無ければ、MMLファイルと同じディレクトリにMGSファイルが生成されます。エラーがあった場合は，エラー情報を表示して終了します。

オプションは -Tのみ有効です。このオプションがセットされると、コンパイル後に詳細情報が表示されます。ただし、MML ファイル内に#track_status命令 が記述されている場合は、-Tオプション指定の有無にかかわらず、詳細情報が表示されます。

main.cppがMGSCクラスの利用サンプルを兼ねているので参照してください。 mgsc.hをインクルードすると，クラスMGSCが利用可能になるので、mml入力用と，ファイル出力用のストリームを用意して、

int MGSC::Compile(std::iostream *mml, std::iostream *mgs);

メソッドを呼び出すだけコンパイルができます。

• mmlは入力用にオープンしておく必要があります。
• mmlから読み込めるデータは、改行コードがCR+LFのテキストの必要があります。
• mgsは入出力用にオープンしておく必要があります。
• mgsはstd::ios::binaryフラグ付きでオープンしてください。

Compile関数はCP/Mエミュレータが異常終了した場合falseを返し、正常終了時はtrueを返します。 この値がコンパイル成功失敗の判定では無いことに注意してください。コンパイル成功失敗の判定が必要な場合、mgs ストリームに書き込まれたサイズを確認します。コンパイルに失敗した場合、mgsストリームには一切書き込みが行われません。

MGSCクラスはコンパイル状況を標準出力に表示しますが、これをユーザーが用意した出力ストリームに置き換える場合には、

void MGSC::SetConsole(std::istream *cin, std::ostream *cout);

を利用してください。

• mgsc-com.h は MSX版 MGSC.COM のダンプデータです。著作権はAin、GIGAMIXの両氏が保有しています。
• Z80エミュレーションにMamiya氏作のKMZ80を利用しています。KMZ80はMamiya 氏によりPublic Domain宣言されています。

cppファイルのフォーマットはclang-format -style=LLVMを利用しています。