変数

テンプレート変数はテンプレートのデータを保存して再利用する便利な手段です。以下の各項目ではどのように変数を定義してテンプレート変数を利用するかを説明します。

変数の定義

変数の定義の方法は以下のようになります。

$<name> = <value>

ここで<name>にはアルファベットおよび数字が利用できます。<value>は値・別の変数・マクロのいずれかになります。

簡単な定義の例:

$foo = %className%

変数の定義には、以下の値を利用することができます。

テンプレート置換マクロ・フィールド置換マクロ・機能マクロの戻り値
引用符(")で囲まれたテキスト
別の変数の参照

定義のルール

変数の定義には次のルールが適用されます。

変数は定義されたテンプレート内でのみ利用できます。つまり、定義した変数は別のテンプレートでは利用できません。
それぞれの変数は空白を入れずに行の先頭で定義する必要があります。
変数は名前の先頭に$がつきます。例えば、$fooのようになります。
変数は利用する前に定義あるいは宣言する必要はありません。
変数の内容は=あるいは+=で定義されなくてはなりません。
複数の文字列を+でつなげることもできます。

例

フィールド置換マクロの利用:

$foo = %opTag:"bar"%

テキストの利用:

$foo = "bar"

別の変数の利用:

$foo = $bar

テンプレート置換マクロの利用:

$ops = %list="Operation" @separator="\n\n" @indent="\t"%

演算子の利用: (+=) :

$body += %list="Operation" @separator="\n\n" @indent="\t"%

上の定義の例は次の例と同じです:

$body = $body + %list="Operation" @separator="\n\n" @indent="\t"%

複数の文字列の連結:

$templateArgs = %list="ClassParameter" @separator=", "%

$template ="template<" + $templateArgs + ">"

変数の参照

変数の値は以下の方法で参照することができます。

$<name>

ここで <name>は以前に定義された変数名を指します。

変数の参照は以下のように利用します。

マクロの一部として利用。例えば、機能マクロの引数として利用する場合。
他の変数の定義に利用。
変数の中身を直接ソースコードとして出力。

注意:

変数を定義する前に参照することもできます。この場合、変数の中身は空文字列であると仮定されます。

例1:

　変数をマクロの一部として利用します。次の例は既定のC++のClassNotesテンプレートの一部です。

$wrapLen = %genOptWrapComment%

$style = %genOptCPPCommentStyle%

%if $style == "XML.NET"%

%XML_COMMENT($wrapLen)%

%else%

%CSTYLE_COMMENT($wrapLen)%

%endIf%

変数を定義してスタイルと折り返す文字列の長さを格納します。

条件文の一部として$styleを参照します。

機能マクロの引数として$wrapLenを参照します。

例2:

変数を別の変数の定義に利用します。

$foo = "foo"

$bar = "bar"

$foobar = $foo + $bar

変数を定義します。

$foobar変数は"foobar"という値を持ちます。

例3:

変数の値を出力します。

$bases=%ClassInherits%

...

class %className%$bases

ClassInheritsテンプレートの結果を$basesに格納します。

クラス名の後に$basesの中身を出力します。