BuildGraph スクリプトのエレメント

BuildGraph スクリプトは XML で記述されます。このドキュメントでは、BuildGraph スクリプト内にあるデータの種類と全体的な構造について説明します。

エレメント

エレメント は、そこに含まれるデータを表し、BuildGraph スクリプトの基本的な構成要素になります。以下の表には、メタデータとして提供され、ビルド システムで実行するとエクスポートされるアイテムがあります。BuildGraph によって直接使用されなくても、これらはローカルでタスクを実行するときに [META] とタグ付けされます。

グラフ構造

BuildGraph スクリプトは、通常以下のエレメントで定義されます。

• <Node>

• <Aggregate>

• <Agent>

• <Trigger>

Node

<Node> は、入力と出力のセットを持つ BuildGraph の最小実行単位です。各 <Node> は、順番に実行されるタスクのシーケンスで構成されます。

Aggregate

<Aggregate> は、生成されたタグセットまたは他のノードのセットの同義として使用可能な名前付きの aggregate を宣言します。

Agent

<Agent> は、シーケンスで実行される (中間ディレクトリをクリーニングせずに) ノードのエージェントの要件を定義します。 ローカルでビルドする場合、<Agent> の要件は無視されますが、指定しなければなりません。

Trigger

<Trigger> は、グラフの一部のコンテナの役割を果たします。ユーザーが明示的に操作する場合に限り実行されます。トリガーの後にノードを実行するには、 -Trigger=<Name> をコマンドラインに渡します。

プロパティの操作

BuildGraph のプロパティは、以下のエレメントで修正することができます。

• <Property>

• <Option>

• <EnvVar>

Property

<Property> は、プロパティの値を設定します。外部のスコープにあるプロパティが既に同じ名前で宣言されている場合、<Property> がそれを上書きします。それ以外の場合はカレント スコープで新しいプロパティが宣言されます。

Option

<Option> は、コマンドラインから設定可能なユーザー オプションを定義します。 <Option> はグローバル スコープでのみ表示されます。

EnvVar

<EnvVar> は、環境変数のコンテンツを含めるプロパティを宣言します (または設定されていない場合は空の文字列)。 <EnvVar> はグローバル スコープでのみ表示されることがあります。

Flow Control

以下のエレメントで BuildGraph スクリプトのフローを制御することができます。

• <Include>

• <Do>

• <Switch>

• <ForEach>

Include

<Include> は、別の BuildGraph スクリプトのコンテンツをこのファイル内で表示されているかのように処理します。 <Include> はグローバル スコープでのみ表示されることがあります。

Do

<Do> はエレメントのシーケンスをグループ化し、条件式の結果が true の場合のみこうしたものを処理します。

Switch

<Switch> は C の switch 文に類似しています。ブランチのシーケンスの条件を評価し、結果が true になった最初の文を処理するからです。

<Switch> 文の例:

	<Switch>
		<Case If=X>
			<Elements go here if X is true>
		</Case>
		<Case If=Y>
			<Elements go here if X is false but Y is true>
		</Case>
		<Default>
			<Elements go here otherwise>
		</Default>
	</Switch>
Copy full snippet

<Switch> <Case If=X> <Elements go here if X is true> </Case> <Case If=Y> <Elements go here if X is false but Y is true> </Case> <Default> <Elements go here otherwise> </Default> </Switch>

ForEach

<ForEach> は、エレメントのボディを、セミコロンで区切られるリストの各アイテムに割り当てられた任意のプロパティで展開します。

<ForEach> 文の例：

	<ForEach Name="Counter" Values="1;2;3;4;5">
		<Log Message="Counter=$(Counter)"/>
	</ForEach>
Copy full snippet

<ForEach Name="Counter" Values="1;2;3;4;5"> <Log Message="Counter=$(Counter)"/> </ForEach>

診断

以下のエレメントで BuildGraph スクリプトの診断を行うことができます、

• <Warning>

• <Error>

Warning

<Warning> はグラフ実行前に警告メッセージを出力します。<Warning> は、node、 agent、 trigger またはグローバル スコープに含まれる場合があります。<Warning> は実行されているターゲットにトリムされた後、 まだグラフの一部である場合に出力します。

Error

<Error>はエラー メッセージを出力します <Error> node、 agent、 trigger またはグローバル スコープに含まれる場合があります。<Error> は、実行されているターゲットにトリムされた後、まだグラフの一部であれば出力します。