変換関数のライフサイクル

コンパイルエンジンの内部はそれぞれのフェーズに応じた処理クラスが定義されており、変換処理が実行されると以下の順序で処理を実行していきます。

• スクリプトファイルのロード(Loader)
  TESスクリプトファイルをロードし、行単位に分割してメモリ上へ格納します。
  モジュール内でこの処理を制御する特別な処理はありません。
• スクリプトの字句解析(Splitter)
  ロードしたTESスクリプトファイルの字句解析を行い、タグ名やパラメータへと分割を行います。
  デフォルトではコアエンジンの分割関数を利用して字句解析を行いますが、モジュール内にタグ名へ対応する分割関数が定義されている場合、代わりに呼び出されます。
• スクリプトの文法チェック(Validator)
  タグごとに設定されたパラメータの入力制約に沿っているか検証を行います。
  モジュール内にタグへ対応する制約定義が存在する場合、検証処理が行われます。
  検証処理はエンジンに標準搭載されているものに加え、モジュール内で定義された独自のバリデーション関数を呼び出すことが可能です。
• スクリプトの変換処理(Converter)
  スクリプトをRPGツクール上で実行可能なイベントデータへと変換します。
  モジュール内に定義された、タグへ対応する変換関数を呼び出し、イベントデータを作成します。
  タグ名に対応する変換処理が見つからない場合はエラーとなります。

また、各処理は前処理、本処理、後処理の３ブロックに分割されており、それぞれの処理後にモジュールに定義した割込関数を呼び出すことができます。

分割関数

分割関数はモジュールのsplitFuncsにタグ名をキーとした関数オブジェクトとして定義します。

module.splitFuncs['choice_h'] = function(text, tag) {
	var arrayArgs = {};
	var args = this.getCommandArgs(text, arrayArgs);
	var temp = {
		labels: arrayArgs.label
	};

	if (args.cancel !== undefined) temp.cancel = args.cancel;

	this.addData(tag, temp);
};

分割関数の仕様は以下の通りです。

引数

• text
  コマンド行全体の文字列です。
• tag
  タグ名です。

戻り値

ありません。

渡されたコマンド文字列を解析結果としてエンジンに引き渡す場合はSplitterクラスのaddDataメソッドを呼び出します。
addDataメソッドの仕様は以下の通りです。

引数

• tag
  タグ名です。
• args
  タグのパラメータオブジェクトです。

戻り値

ありません。

バリデーション定義

バリデーション定義はモジュールのvalidatesに、タグ名をキーにしたオブジェクトとして定義します。

module.validates['scroll_h'] = {
	speed: {
		notEmpty: [],
		isNumeric: [1, 8]
	},
	noskip: {
		isBool: []
	}
};

定義オブジェクトのフィールドには、タグパラメータの名称を指定します。フィールドはタグパラメータの制約条件を定義し、制約名をキー、値に制約へ渡すパラメータの配列を指定します。
上記の例では、scroll_hタグはspeed、noskipにそれぞれ制約条件を保持しており、speedは空文字の入力不可で、かつ1～8までの数値を指定する必要があります。

エンジン標準の制約条件には以下が定義されています。

• notEmpty
  必須入力の項目に設定します。
• isBool
  boolean型の項目に設定します。
• isNumeric
  数値型の項目に設定します。
• list
  入力項目が指定した一覧のいずれかに該当する項目に設定します。
• zeroCheck
  0の入力が不可能な項目に設定します。
• regCheck
  入力項目が指定した正規表現にマッチする項目に設定します。

バリデーション関数

バリデーション関数はモジュールのvalidateFuncsに、制約名をキーとした関数オブジェクトとして定義します。

module.validateFuncs['varCheck'] = function(vargs, paramName, params) {
	if (params[paramName] == null) return;

	var $ = params[paramName].match(vargs[0]);

	// 変数指定ではない
	if ($ == null) return;

	if ($[vargs[1]] != null) {
		if (parseInt($[vargs[2]], 0) == 0) {
			throw new Tes.ValidateError(
				'[' + paramName + '] : 「0」が使われました。',
				'validator.zeroCheck.error',
				[paramName]
			);
		}
	}
};

バリデーション関数の仕様は以下の通りです。

引数

• vargs
  バリデーション制約の引数です。
• paramName
  パラメータ名です。
• params
  パラメータオブジェクトです。

戻り値

ありません。

バリデーションのエラー発生時は、Tes.ValidateErrorをthrowしてください。
コンパイルエンジン上で文法エラーとして処理されます。

変換関数

変換関数はモジュールのconvertFuncsにタグ名をキーとした関数オブジェクトとして定義します。

module.convertFuncs['input_num'] = function(args) {
	return {
		code: 103,
		indent: this._indent,
		parameters: [
			parseInt(args['var'], 10),
			parseInt(args['num'], 10)
		]
	};
};

変換関数の仕様は以下の通りです。

引数

• args
  タグのパラメータオブジェクトです。

戻り値

イベントデータのオブジェクトです。
オブジェクトのフィールドはすべて必須です。

• code
  インタープリタのコマンドコードです。
• indent
  イベントのインデントです。
  原則として、Converterオブジェクトの_indentフィールドをセットします。
• parameters
  イベントパラメータの配列です。

割込関数

割込関数はモジュールの下記のフィールドに処理フェーズ名をキーにした関数オブジェクトとして定義します。

• preProcessors : 前処理
• processors : 本処理
• postProcessors : 後処理

処理フェーズは以下のキーを指定します。

• loader : スクリプトファイルのロード
• splitter : スクリプトの字句解析
• validator : スクリプトの文法チェック
• converter : スクリプトの変換処理
• deconverter : スクリプトの逆変換処理

module.postProcessors['converter'] = function() {
	// この処理は変換処理の後処理として呼ばれる
};

割込関数の引数、戻り値はありません。
関数上では各処理クラスのインスタンスがthisとして参照することが可能です。