T4 テンプレートで、ソリューション構成に応じた処理の切り替え ( 条件コンパイルっぽい動作 ) を行うには

地味にけっこう便利な T4 テンプレート。

すなわち、拡張子 .tt のファイル中に C# や VB などのプログラミング言語でテキストテンプレートを記述することで、.cs や .vb などなど、別のソースファイルを自動生成しちゃおうというもの。

さてところで、この T4 テンプレート中に記述する C# コードにおいて、現在選択されているアクティブなソリューション構成が "Release" か "Debug" かに応じて、処理を切り替えたい需要が発生した。

普通の C# ソースコード中であれば、プロジェクト構成で条件付きコンパイルシンボルを別途定義したり、はたまた「DEBUG 定数の定義(U)」のチェックを On にしたりしておくことで、あとは、

#if DEBUG
...
#else
...
#end

などと書くことで、条件コンパイルができる。

ところが、T4 テンプレートは、.tt を処理するのはテンプレートホストと呼ばれるものであって、通常の C# コンパイラが直に Visual Studio ( というか MSBuild ) から呼び出されるわけではない。

そのため、T4 テンプレート中に #if DEBUG ～ #else ～ #end と記述しても、たしかにコンパイルエラーにこそならないが、いっぽうで、シンボル: DEBUG を定義してくれる人は誰も居ない。

そのため、Visual Studio 管理下のプロジェクト配下では、T4 テンプレート中の C# コードでのソリューション構成の切り替えに応じた条件コンパイルは、事実上無理がある。

だがしかし。

ところで、T4 テンプレート中に記述するコード上では、その .ttファイルを処理する "ホスト" オブジェクトを参照可能である。

このホストオブジェクトをたどると、なんと、Visual Studio の IDE オブジェクトをたぐれるのだ!

Visual Studio IDE オブジェクトを捕まえることができたら、アクティブなソリューション構成の名前を取得するのも朝飯前である。

条件 "コンパイル" とはいかないが、アクティブなソリューション構成に応じて、生成される出力ファイルの内容を変化させたり、ソリューション構成が "Debug" のときだけログを吐いたりすることが可能になる。

具体的には、まず、.tt コード中からホストオブジェクトに Host というプロパティ名でアクセスできるよう、template ディレクティブに hostspecific="true" を記述する。

<#@ template debug="false" hostspecific="true" language="C#" #>

続けて、Visual Studio IDE オブジェクトを扱えるよう、EnvDTE アセンブリへの参照設定を、同じく .tt コード中のディレクティブで指定する。

<#@ assembly name="EnvDTE" #>

ここまで準備すれば、あとは、
1. Host プロパティから IServiceProvider インターフェースを入手し、
2. IServiceProvider インターフェース経由で、Visual Studio IDE オブジェクトを入手、
3. Visual Studio IDE オブジェクトにソリューション構成を問い合わせ
すれば OK である。

<#
var serviceProvider = this.Host as IServiceProvider;
var dte = serviceProvider.GetService(typeof(EnvDTE.DTE)) as EnvDTE.DTE;
if (dte.Solution.SolutionBuild.ActiveConfiguration.Name == "Debug"){
　...
}
#>

これで、アクティブなソリューション構成の名前に応じた、処理の仕分けが T4 テンプレートでも可能となった。

なお、しかしながら、TextTransform.exe による変換実行など、Visual Studio 配下にない状況での出力においては、当然、Visual Studio IDE オブジェクトは存在しないので、上記手法は使えない。

この点はくれぐれも注意されたし。