MugenPowerStudio 仕様

はじめに

本書はmugen関連各種ファイルをターゲットとした，
VisualStudioCode拡張機能の仕様書である．

基本情報

本拡張機能は次の機能を持つ．

• 機能1：シンタックスハイライト
  　mugen関連各種ファイルをVisualStudioCodeで開いた際に，
  　ソースコードが特定の規則に沿って着色された状態で表示される．

• 機能2：パケージング　　※未実装
  　HTMLのおけるCSSのように，
  　Trigger or StateDefのパラメータ or StateControllerのパラメータ or StateController
  　をまとめて１つのシンボルに置き換えることができる．

• 機能3：グリンプスディスプレイ(GPDP)　　※未実装
  　airファイルを編集する際に，紐づくスプライトが脇に表示される．

サポート範囲は各機能それぞれ次の通り．
※そもそも項目にないVerは未サポート．

• 機能1：シンタックスハイライト
  (キャラクター用のdef,cmd,air,cnsファイルのみサポート．)

  win	1.0	1.1b
  〇	△	△

• 機能2：パケージング
  (キャラクター用のcmd,cnsファイルのみサポート．)

  win	1.0	1.1b
  ×	×	×

• 機能3：グリンプスディスプレイ
  (キャラクター用のairファイルのみサポート．)

  win	1.0	1.1b
  ×	×	×

機能1：シンタックスハイライト（ソースに着色）

VisualStudioCodeに標準的に用意されている仕組みの１つ．
ある規則で書かれた文字列に対し，それがどういう区分の文字列なのかを
指定することで，配色テーマに合わせた色が付く仕組み．
本拡張機能ではmugen用に文字列の規則に対する区分を定義している．

defファイル

次の規則に基づき，色付けする．
※規則が競合した場合，記載順の早いものが優先される．

• コメント　　例「; 回数カウント用」

  • 区分：comment.line　←　行コメント．
  • 規則：『;』から改行コードまで．
  • 補足：-

• タイトル　　例「[Info]」「[Files]」

  • 区分：entity.name.type　←　実体のクラス，型．
  • 規則：『[』で始まり『]』で終わる．(文頭が『[』で始まる行のみ．)
  • 補足：-

• パラメータ　　例「cns = T-H-M-A.cns」「pal1 = Act/t3.act」

  • 区分：要素分けし，各要素で指定．
  • 規則：『A = B』の形をしている．
  • 補足：A = B を (A) (=) (B) の3要素に分ける．
  • 要素1 ：(A)
    • 区分：variable.parameter　←　パラメータとして宣言された変数．
    • 規則：『A = B』の (A)．
    • 補足：-
  • 要素2 ：(=)
    • 区分：keyword.operator　←　キーワードの演算子．
    • 規則：『A = B』の (=)．
    • 補足：-
  • 要素3 ：(B)
    • 区分：constant.numeric.def　←　定数(主に数字)．
    • 規則：『A = B』の (B)．
    • 補足：-
    • (B)の例外1
      • 区分：keyword.other　←　キーワードのその他．
      • 規則：(B)に含まれる『/』．
      • 補足：-
    • (B)の例外2
      • 区分：string.quoted.double　←　”に囲われた文字列．
      • 規則：(B)に含まれかつ『"』に挟まれた文字．
      • 補足：-

cmd & cnsファイル

次の規則に基づき，色付けする．
※規則が競合した場合，記載順の早いものが優先される．

• コメント　　※defのコメントと同じ

• まる括弧　　例「"Ver(13)」「(pos y >= 0) && movehit」

  • 区分：keyword.other　←　キーワードのその他．
  • 規則：『(』『)』に対して適用．
  • 補足：-

• AND OR　　例「movehit || (pos y >= 0) && (vel y > 0)」

  • 区分：keyword.other　←　キーワードのその他．
  • 規則：『&&』『||』に対して適用．
  • 補足：-

• トリガー　　例「trigger1 = time > 0」

  • 区分：要素分けし，各要素で指定．
  • 規則：『trigger〇〇 =』or『Trigger〇〇 =』の形をしている．
  • 補足：trigger〇〇 = を (trigger〇〇) (=) の2要素に分ける．
  • 要素1 ：(trigger〇〇)
    • 区分：keyword.control　←　フロー制御に関連するキーワード．
    • 規則：『trigger〇〇』『Trigger〇〇』に対して適用．
    • 補足：-
  • 要素2 ：(=)
    • 区分：keyword.other　←　キーワードのその他．
    • 規則：『=』に対して適用．
    • 補足：-

• パラメータ　　※基本defのパラメータと同じだが次の相違点がある．

  • 『=』の他に『!=』『>』『<』『>=』『<=』『&』『|』『^』『:=』でも要素2扱い．
  • 『 』(半角空白)が1個までなら要素1扱い．
    　例「pos X <= 80」要素1『 』1個．
  • 『, 』『+』『-』『*』『/』『**』『%』『|』『&』が19個までなら要素3扱い．
    　例「command = ~D, B, U, D, a」要素3『, 』4個．
  • 要素3 ：(B) に3つ目の例外がある．
    • 区分：keyword.control　←　フロー制御に関連するキーワード．
    • 規則：『ifelse』に対して適用．
    • 補足：-

• タイトル　　例「[Statedef 3000 ]」「[State 3210, ChangeState]」

  • 区分：entity.name.type　←　実体のクラス，型．
  • 規則：『[』で始まり『]』で終わる．(文頭が『[』で始まる行のみ．)
  • 補足：-
  • 例外
    • 区分：keyword.other　←　キーワードのその他．
    • 規則：[]に挟まれる『Statedef』『statedef』．
    • 補足：-

airファイル

次の規則に基づき，色付けする．
※規則が競合した場合，記載順の早いものが優先される．

• コメント　　※defのコメントと同じ

• パラメータ　　例「cns = T-H-M-A.cns」「pal1 = Act/t3.act」

  • 区分：要素分けし，各要素で指定．
  • 規則：『A = B』の形をしている．
  • 補足：A = B を (A) (=) (B) の3要素に分ける．
  • 要素1 ：(A)
    • 区分：variable.parameter　←　パラメータとして宣言された変数．
    • 規則：『A = B』の (A)．
    • 補足：-
  • 要素2 ：(=)
    • 区分：keyword.operator　←　キーワードの演算子．
    • 規則：『A = B』の (=)．
    • 補足：-
  • 要素3 ：(B)
    • 区分：constant.numeric.def　←　定数(主に数字)．
    • 規則：『A = B』の (B)．
    • 補足：-

• スプライト　　例「10040, 1, 0, 0, 1」「10040,1, 0,0, 1」「10040,1,0,0,1」

  • 区分：要素分けし，各要素で指定．
  • 規則：『A, B, C, D, E』or『A,B, C,D, E』or『A,B,C,D,E』の形をしている．
  • 補足：(A) (B) (C) (D) (E) の5要素に分ける．※『,』は着色しない．
  • 要素1 ：(A)
    • 区分：constant.character.escape　←　エスケープシーケンス．
    • 規則：『A, B, C, D, E』or『A,B, C,D, E』or『A,B,C,D,E』の (A)．
    • 補足：区分は色で選んだ．
  • 要素2 ：(B)
    • 区分：constant.character.escape　←　エスケープシーケンス．
    • 規則：『A, B, C, D, E』or『A,B, C,D, E』or『A,B,C,D,E』の (B)．
    • 補足：区分は色で選んだ．
  • 要素3 ：(C)
    • 区分：string.quoted　←　引用符で囲まれた文字列．
    • 規則：『A, B, C, D, E』or『A,B, C,D, E』or『A,B,C,D,E』の (C)．
    • 補足：区分は色で選んだ．
  • 要素4 ：(D)
    • 区分：string.quoted　←　引用符で囲まれた文字列．
    • 規則：『A, B, C, D, E』or『A,B, C,D, E』or『A,B,C,D,E』の (D)．
    • 補足：区分は色で選んだ．
  • 要素5 ：(E)
    • 区分：keyword.control　←　制御フロー．
    • 規則：『A, B, C, D, E』or『A,B, C,D, E』or『A,B,C,D,E』の (E)．
    • 補足：区分は色で選んだ．

• スプライト向きまで指定　　例「10040,1, 0,0, 1, H」「10, 1, 0, 0, 1,　H」「10,1,0,0,1,H」

  • 区分：要素分けし，各要素で指定．
  • 規則：『A, B, C, D, E, F』or『A,B, C,D, E, F』or『A,B,C,D,E,F』の形をしている．
  • 補足：(A) (B) (C) (D) (E) (F) の6要素に分ける．※『,』は着色しない．
  • 要素1 ：(A)
    • 区分：constant.character.escape　←　エスケープシーケンス．
    • 規則：『A, B, C, D, E, F』or『A,B, C,D, E, F』or『A,B,C,D,E,F』の (A)．
    • 補足：区分は色で選んだ．
  • 要素2 ：(B)
    • 区分：constant.character.escape　←　エスケープシーケンス．
    • 規則：『A, B, C, D, E, F』or『A,B, C,D, E, F』or『A,B,C,D,E,F』の (B)．
    • 補足：区分は色で選んだ．
  • 要素3 ：(C)
    • 区分：string.quoted　←　引用符で囲まれた文字列．
    • 規則：『A, B, C, D, E, F』or『A,B, C,D, E, F』or『A,B,C,D,E,F』の (C)．
    • 補足：区分は色で選んだ．
  • 要素4 ：(D)
    • 区分：string.quoted　←　引用符で囲まれた文字列．
    • 規則：『A, B, C, D, E, F』or『A,B, C,D, E, F』or『A,B,C,D,E,F』の (D)．
    • 補足：区分は色で選んだ．
  • 要素5 ：(E)
    • 区分：keyword.control　←　制御フロー．
    • 規則：『A, B, C, D, E, F』or『A,B, C,D, E, F』or『A,B,C,D,E,F』の (E)．
    • 補足：区分は色で選んだ．
  • 要素6 ：(F)
    • 区分：support.type　←　提供される型．
    • 規則：『A, B, C, D, E, F』or『A,B, C,D, E, F』or『A,B,C,D,E,F』の (F)．
    • 補足：区分は色で選んだ．

• スプライト透過方法まで指定　　例「10,1, 0,0, 1, H, A」「10, 1, 0, 0, 1,　H, A」「10,1,0,0,1,H,A」

  • 区分：要素分けし，各要素で指定．
  • 規則：『A, B, C, D, E, F, G』or『A,B, C,D, E, F, G』or『A,B,C,D,E,F,G』の形をしている．
  • 補足：(A) (B) (C) (D) (E) (F) (G) の7要素に分ける．※『,』は着色しない．
  • 要素1 ：(A)
    • 区分：constant.character.escape　←　エスケープシーケンス．
    • 規則：『A, B, C, D, E, F, G』or『A,B, C,D, E, F, G』or『A,B,C,D,E,F,G』の (A)．
    • 補足：区分は色で選んだ．
  • 要素2 ：(B)
    • 区分：constant.character.escape　←　エスケープシーケンス．
    • 規則：『A, B, C, D, E, F, G』or『A,B, C,D, E, F, G』or『A,B,C,D,E,F,G』の (B)．
    • 補足：区分は色で選んだ．
  • 要素3 ：(C)
    • 区分：string.quoted　←　引用符で囲まれた文字列．
    • 規則：『A, B, C, D, E, F, G』or『A,B, C,D, E, F, G』or『A,B,C,D,E,F,G』の (C)．
    • 補足：区分は色で選んだ．
  • 要素4 ：(D)
    • 区分：string.quoted　←　引用符で囲まれた文字列．
    • 規則：『A, B, C, D, E, F, G』or『A,B, C,D, E, F, G』or『A,B,C,D,E,F,G』の (D)．
    • 補足：区分は色で選んだ．
  • 要素5 ：(E)
    • 区分：keyword.control　←　制御フロー．
    • 規則：『A, B, C, D, E, F, G』or『A,B, C,D, E, F, G』or『A,B,C,D,E,F,G』の (E)．
    • 補足：区分は色で選んだ．
  • 要素6 ：(F)
    • 区分：support.type　←　提供される型．
    • 規則：『A, B, C, D, E, F, G』or『A,B, C,D, E, F, G』or『A,B,C,D,E,F,G』の (F)．
    • 補足：区分は色で選んだ．
  • 要素7 ：(G)
    • 区分：constant.language　←　そのプログラム言語における特別(一般的)な定数．
    • 規則：『A, B, C, D, E, F, G』or『A,B, C,D, E, F, G』or『A,B,C,D,E,F,G』の (G)．
    • 補足：区分は色で選んだ．

• タイトル　　※defのコメントと同じ