個人的に、前々から「T4 は将来性が見えなさ過ぎてもう使うのやめたい」と言い続けていたわけですが、 最近ようやく自分が保守している T4 を全部別の手段で書き換えたので、 今日はそれの話。

T4 (Text Template Transformation Toolkit)

テキスト テンプレートというと、ひな形的なテキストを簡易な文法で生成するようなものです。

例えば、

public static bool TryParse(this string s, out {{T}} x) => {{T}}.TryParse(s, out x);

みたいな文字列の、{{T}} のところに bool, byte, int, double を与えて、

public static bool TryParse(this string s, out bool x) => bool.TryParse(s, out x);
public static bool TryParse(this string s, out byte x) => byte.TryParse(s, out x);
public static bool TryParse(this string s, out int x) => int.TryParse(s, out x);
public static bool TryParse(this string s, out double x) => double.TryParse(s, out x);

とかを生成したいことがたまにあります。

今書いたみたいに4種・4行程度なら手書きでも全然かまわないんですが、 sbyte, short, ushort, ... と増やしていくとテキスト テンプレートに頼りたくなります。

C# でテキスト テンプレートというと、 T4 (Text Template Transfomration Toolkit)が有名ではあります。

T4 を使うと、上記の Parse は以下のように書けます。

<#
var types = new[] { "bool", "byte", "int", "double" };

foreach (var t in types)
{
#>
    public static bool TryParse(string s, out <#= t #> x) => <#= t #>.TryParse(s, out x);
<#
}
#>

T4 の今

元々 Entity Framework が内部で使っていたツールを公にしてしまったものですよね、確か。 今となっては本当に「してしまった」みたいな言い方にした方がいいと僕は本気で思っているんですけども。 どうも、.NET の中の人も、Entity Framework チーム以外あんまり乗り気で使っている風には見えず。 真面目に使う気があるのなら今時もうちょっと改良されててもよさそうなものなのに、 ちょっと塩漬け感があります。

例えば以下のような問題あり。

• Visual Studio でしか動かず、しかも、手作業で .tt ファイルを開いて保存したタイミングでしかテキスト生成が走らない
  • 今時あれば、Roslyn Source Generator 化すれば dotnet build でテキスト生成できるのにやってない
  • Git とかで管理するなら、生成結果のテキストもコミットする運用になる
• Visual Studio 自体の表示言語に生成結果が依存する
  • 編集して保存した人の表示言語によって生成結果が変わる
  • 無駄に差分が出て、Git とかの差分が悲惨
• csproj 内にいろいろとゴミが残る
  • <Service Include="{508349b6-6b84-4df5-91f0-309beebad82d}" /> とか
  • System.CodeDom の参照とか
  • <None Update="T4Generator.tt"> みたいなのとか

さらに、中間的に作られる「テキスト生成するための generator クラス」がまたかなり悲惨だったりします。

一例: 元 tt ファイル → 生成される generator クラス

例えば、元 tt ファイルで <#= t #> みたいになっているところは generator 内では ToStringWithCulture(t) みたいに展開されるんですが、 この ToStringWithCulture の中身は以下のようになっています。

public string ToStringWithCulture(object objectToConvert)
{
    if ((objectToConvert == null))
    {
        throw new global::System.ArgumentNullException("objectToConvert");
    }
    System.Type t = objectToConvert.GetType();
    System.Reflection.MethodInfo method = t.GetMethod("ToString", new System.Type[] {
                typeof(System.IFormatProvider)});
    if ((method == null))
    {
        return objectToConvert.ToString();
    }
    else
    {
        return ((string)(method.Invoke(objectToConvert, new object[] {
                    this.formatProviderField })));
    }
}

任意の型に対してカルチャー(IFromatProvider)指定するためだけにリフレクション。 しかも、MethodInfo のキャッシュもせず、毎回律義に GetMethod。 さらに、常に object 引数で受け取っているので、int (おそらく最多で渡される)とかだと都度ボックス化。

T4 が作られた当初ならしょうがなかったのかもしれないですけどねぇ。 今なら、単に string.CreateとかStringBuilder.Appendでカルチャー指定もできるのに。 というか、むしろ、カルチャー依存やめろ、誰得。

ちなみに、T4 生成の generator クラスと、自前で文字列補間を使って書いた generator でベンチマークを比べると、一例として以下のテーブルくらいの差が出ます。

Method	Mean	Error	StdDev
T4	19,247.7 ns	74.46 ns	69.65 ns
Interpolation	330.6 ns	5.94 ns	5.55 ns

2桁差。 2倍ではなく、2桁。 マイクロ秒とナノ秒の補助単位違いレベル。

という感じで、T4、 さすがに中身がグダグダすぎ、かつ、近代化される気配がまるっきり皆無でつらいかなと思います。 テンプレートの文法とかはそこまでおかしくもないんですけどね。 さすがにもう使っていられないかなと…

脱 T4

ということで脱 T4 の話。

ただ、T4 の用途は2種類ありまして、それぞれ代替手段が異なります。

• TextTemplatingFilePreprocessor: 上記でいう「generator を作る」ところまでやるモード
• TextTemplatingFileGenerator: さらにその generator を実行して、最終結果を直接生成するモード

TextTemplatingFilePreprocessor

「generator を作るところまで」の方。

TextTemplatingFilePreprocessor な T4 はもう本当に存在意義がないですね。 先ほどすでに「文字列補間で自前で」とかやっていますが、 文字列補間で十分です。

特に、C# 10 で文字列補間のパフォーマンスが劇的に向上していますし、 C# 11 で入った生文字列リテラルによってテンプレートも書きやすくなっています。 本校冒頭で書いたテンプレートなら、普通に以下のように書けます。

using System.Text;

var s = new StringBuilder();

foreach (var t in new[] { "bool", "byte", "int", "double" })
{
    s.Append($$"""
            public static bool TryParse(string s, out {{t}} x) => {{t}}.TryParse(s, out x);

        """);
}

(カルチャー指定が必要なら Append メソッドの第1引数を追加。)

テキスト テンプレートとしては結構冗長ですけども、まあ、許容範囲で、 「素の C# だけで書けてる」ということを考慮すると十分満足の行くコードじゃないかと思います。

T4 からの移行も割かし簡単で、 こんな感じのコードで置換を掛けるだけで行けます。

• <#= ～ #> を、{{ ～ }} に置換
• #> を s.Append($$""" に置換
• <# を """); に置換

(これだと不足もあるんですが、あとは手での書き換えでもなんとかなるレベル。)

TextTemplatingFileGenerator

「generator を実行までして最終結果を直接得る」の方。

こっちはさすがに素の C# ではできないんですが。 ビルド時に何かしらのテキストを生成するものというと、最近だと Roslyn Source Generator です。

T4 も、テンプレートの文法自体に不満はそこまでないので、Source Generator 実装に置き換わっていたらそれを普通に使うんですけどね… ここ数年定期的に「誰か T4 を Source Generator 実装しなおしてないかな」とか検索したりしてたんですが… いないですね。一向に。

そして、「ないので自分で作ろう」ってなったときに、なかなかきれいな T4 エンジン ライブラリが見つからず。 「だったらもっと楽に使えそうな別のテンプレート エンジンを使いたい」となりまして。 結局、Source Generator で一番使いやすそうだったのが scriban でした。

• scriban

ということで作ったのがこれです:

• ScribanSourceGenerator
• 利用例

例えば以下のような拡張子 .scriban のファイルを置くか、

static class Extensions
{
{{
for $t in ["bool","byte","int","double"]
~}}
    public static bool TryParse(this string s, out {{$t}} x) => {{$t}}.TryParse(s, out x);
{{ end }}
}

以下のようにクラスに属性を付けてコード生成できます。

namespace FileGenerator;

[ScribanSourceGeneretor.ClassMember("""
    {{
    for $t in ["bool","byte","int","double"]
    ~}}
        public static bool TryParse(this string s, out {{$t}} x) => {{$t}}.TryParse(s, out x);
    {{ end }}
    """)]
internal static partial class Extensions
{
}