Bve5_Parsing 0.8.0

Bve5_Parsing

Bve5構文のC#パーサライブラリです。 Bve5の構文はどのように処理されているのか？という疑問を解消すべく、パーサジェネレータ「ANTLR」を利用し、Bve5.7構文のパーサを実装してみました。現在、Bve5.7.6224.40815の一部構文に対応しています。 特にイレギュラーな入力(引数の数が異なる,構文名が異なる等）に対する処理が本家ソフトウェアと比べてかなり相違があります。

Notes on use

Bve5_Parsingは開発中のライブラリです。Nugetでパッケージを公開してますが、破壊的変更を行う可能性があるのでバージョンアップには注意して下さい。

Supported Syntaxes

• Scenario File

  • Bve5.7全構文に対応
  • namespace: ScenarioGrammar
  • 出力: ScenarioDataクラス 構文解析の結果は、ScenarioDataクラスで返します。ScenarioDataクラスは以下のフィールドで構成されています。
    • string Version: シナリオファイルのバージョン情報
    • List<FilePath> Route: マップファイルの相対パス
    • List<FilePath> Vehicle: 車両ファイルの相対パス
    • string Image: サムネイル画像の相対パス
    • string Title: シナリオタイトル
    • string RouteTitle: 路線名
    • string VehicleTitle: 車両名
    • string Author: 路線と車両の作者
    • string Comment: シナリオの説明

  なお、RouteとVechicleに関しては、複数ファイルの指定と重み係数に対応するため、相対パスと重み係数をまとめたFilePath構造体のリストを返します。相対パスはFilePath.Value、重み係数はFilePath.Weightに対応しています。

  詳しくは、ScenarioData.csを参照してください。

• Map File

  • Bve5.7全構文と変数、一部の古い構文(Legacy構文)に対応

  • namespace: MapGrammar

  • 出力: MapDataクラス 構文解析の結果は、MapDataクラスで返します。MapDataクラスは以下のフィールドで構成されています。

    • string Version: バージョン情報
    • string Encoding: ファイルエンコーディング
    • string StructureListPath: ストラクチャリストの相対パス
    • string StationListPath: 停車場リストの相対パス
    • string SignalListPath: 信号リストの相対パス
    • string SoundListPath: サウンドリストの相対パス
    • string Sound3DListPath: 固定音源リストの相対パス
    • List<SyntaxData> Statements: 各構文情報をまとめたSyntaxDataクラスのリスト

  • そのうち、Statementsは各構文情報をまとめたSyntaxDataクラスのリストを返します。SyntaxDataクラスは以下のフィールドで構成されてます。

    • double Distance: 構文の距離程
    • string[] MapElement: 構文のマップ要素(ex.Structure,Repeaterなど)
    • string Key: 構文のキー(Track['この部分'])
    • string Function: 構文の関数名(ex.Interpolate)
    • Dictionary<string, object> Arguments: 構文の引数名。引数がキーであれば型はstring、引数が数値であれば型はdoubleで返します。

  詳しくは、MapData.csを参照してください

その他は今後作っていきます👍

Requirements

• ANTLR4.Runtime(C#)
• .Net Standard 2.0で実装しているため、特定のバージョン以降の.Netであれば利用できます。詳しくはこちらを参照して下さい。

Installation

NugetからBve5_Parsingをインストールするか、このプロジェクトをビルドしてdllを入手し、各自のプロジェクトにインポートしてください。

Usage for C#

ex. C#でMapFileの構文解析を行う場合.

using Bve5_Parsing.MapGrammar;

...
    string input; //String to be analyzed
    MapGrammarParser parser = new MapGrammarParser();

    // 文字列をマップ構文としてパースする
    var mapData = parser.Parse(input);
    // マップファイルへのファイルパスを指定してパースする
    var mapData2 = parser.ParseFromFile(@"PATH_TO_MAP_FILE");
    // Include構文の参照先を再帰的にパースする
    var mapDataWithInclude = parser.ParseFromFile(@"PATH_TO_MAP_FILE", MapGrammarParserOption.ParseIncludeSyntaxRecursively)

    Console.WriteLine(mapData.Version); //マップ構文のバージョン情報を表示
    foreach(var statement in mapData.Statements) {
      /* 各構文情報 */
      Console.WriteLine(statement.Distance); //構文の距離程
      Console.WriteLine(statement.Function); //構文の関数名
    }
...

構文が解析された場合、結果はMapDataクラスで返ってきます。例えば、ファイルヘッダのバージョン情報はMapData.Versionに格納されています。また、構文解析のエラーはMapGrammarParser.ParserErrorsに格納されています。MapGrammarParser.ParserErrorsではエラーの種別(警告かエラーか)やエラーとなった構文の位置、エラーメッセージが取得出来ます。独自のエラーメッセージを実装する場合は、ParserErrorListenerを継承したカスタムクラスを実装し、MapGrammarParser.ErrorListenerに指定して下さい。

Bve5_Parsing.slnに含まれているParseSampleAppプロジェクトからは、コンソール上でパーサの動作を確かめることができます。Bve5_Parsingの実装例として適宜利用して下さい。

Used Librarys

Bve5_Parsing is using the following library.

ANTLR v4

The BSD License (3-clause BSD License)

Copyright (c) 2012 Terence Parr and Sam Harwell

• **ライセンス全文 😗* ANTLR4ライセンス全文

ReadJEnc

The MIT License (MIT)

Copyright (c) 2017 hnx8

• ライセンス全文 ： ReadJEncライセンス全文

License

The MIT License (MIT)

Copyright(c) 2017-2019 aoisupersix

License.md

TechnicalCommentary

Bve5_Parsingの技術解説です。
→ TechnicalCommentary.md