SimpleTextTemplate

SimpleTextTemplateは、変数の埋め込みのみに対応したテキストテンプレートエンジンです。

説明

• 文字列をUTF-8バイト列としてIBufferWriter<byte>に出力します。
• {{ <変数>:<format>:<culture> }}で変数を埋め込みます。（formatとcultureは省略可能）
• {{と}}内の先頭と末尾の空白（U+0020）は無視されます。
• {{と}}で囲まれた範囲以外の文字は、そのまま出力されます。

Important

一部のカルチャーではOSによって定数展開が変わります。

インストール

NuGet（正式リリース版）

dotnet add package SimpleTextTemplate.Generator

Azure Artifacts（開発用ビルド）

dotnet add package SimpleTextTemplate.Generator -s https://pkgs.dev.azure.com/finphie/Main/_packaging/DotNet/nuget/v3/index.json

使い方

次の例では、外部のライブラリであるCommunityToolkit.HighPerformanceを参照しています。

SimpleTextTemplate.Generator（推奨）

using System;
using System.Globalization;
using System.Text;
using CommunityToolkit.HighPerformance.Buffers;
using SimpleTextTemplate;

using var bufferWriter = new ArrayPoolBufferWriter<byte>();
var context = new SampleContext("Hello, World", 1000, new(2000, 1, 1, 0, 0, 0, TimeSpan.Zero));

var writer = TemplateWriter.Create(bufferWriter);
TemplateRenderer.Render(ref writer, "{{ DateTimeOffsetValue:o }}_{{ StringValue }}!", in context);
TemplateRenderer.Render(ref writer, "_{{ ConstantString }}_{{ ConstantInt:N3:ja-JP }}_{{ IntValue }}", in context, CultureInfo.InvariantCulture);
writer.Flush();

// 2000-01-01T00:00:00.0000000+00:00_Hello, World!_Hello_999.000_1000
Console.WriteLine(Encoding.UTF8.GetString(bufferWriter.WrittenSpan));

readonly record struct SampleContext(
    string StringValue,
    int IntValue,
    DateTimeOffset DateTimeOffsetValue)
{
    public const string ConstantString = "Hello";
    public const int ConstantInt = 999;
}

サンプルプロジェクト

生成コード

using System.Runtime.CompilerServices;
using CommunityToolkit.HighPerformance.Buffers;
using SimpleTextTemplate;

file static class Intercept
{
    [InterceptsLocation(1, "...")]
    public static void Write0(ref TemplateWriter<ArrayPoolBufferWriter<byte>> writer, string text, in SampleContext context, IFormatProvider? provider = null)
    {
        writer.WriteValue(Unsafe.AsRef(in context).@DateTimeOffsetValue, "o", CultureInfo.InvariantCulture);
        writer.WriteConstantLiteral("_"u8);
        writer.WriteString(Unsafe.AsRef(in context).@StringValue);
        writer.WriteConstantLiteral("!"u8);
    }

    [InterceptsLocation(1, "...")]
    public static void Write1(ref TemplateWriter<ArrayPoolBufferWriter<byte>> writer, string text, in SampleContext context, IFormatProvider? provider = null)
    {
        writer.WriteConstantLiteral("_Hello_999.000_"u8);
        writer.WriteValue(Unsafe.AsRef(in context).@IntValue, default, CultureInfo.InvariantCulture);
    }
}

SimpleTextTemplate（非推奨）

SimpleTextTemplate.Renderer（非推奨）

SimpleTextTemplateとSimpleTextTemplate.Contextsへの参照が必要です。

using System;
using System.Text;
using CommunityToolkit.HighPerformance.Buffers;
using SimpleTextTemplate;

var symbols = Context.Create();
symbols.Add("Identifier"u8.ToArray(), "Hello, World!"u8.ToArray());

using var bufferWriter = new ArrayPoolBufferWriter<byte>();
var source = "{{ Identifier }}"u8.ToArray();
var template = Template.Parse(source);
template.Render(bufferWriter, symbols);

// Hello, World!
Console.WriteLine(Encoding.UTF8.GetString(bufferWriter.WrittenSpan));

ベンチマーク

Method	Categories	Mean	Error	Ratio	Gen0	Gen1	Allocated
SimpleTextTemplate.Generator	Constant String	13.92 ns	0.155 ns	1.00	0.0067	-	56 B
(Utf8.TryWrite)	Constant String	21.84 ns	0.172 ns	1.57	0.0067	-	56 B
(InterpolatedStringHandler)	Constant String	25.19 ns	0.135 ns	1.81	0.0105	-	88 B
(CompositeFormat)	Constant String	29.75 ns	0.380 ns	2.14	0.0105	-	88 B
SimpleTextTemplate.Generator	Constant Int	12.77 ns	0.043 ns	1.00	0.0048	-	40 B
(Utf8.TryWrite)	Constant Int	12.86 ns	0.086 ns	1.01	0.0048	-	40 B
(InterpolatedStringHandler)	Constant Int	27.47 ns	0.302 ns	2.15	0.0067	-	56 B
(CompositeFormat)	Constant Int	28.08 ns	0.147 ns	2.20	0.0067	-	56 B
SimpleTextTemplate.Generator	String	29.41 ns	0.144 ns	1.00	0.0057	-	48 B
SimpleTextTemplate	String	59.91 ns	0.247 ns	2.04	0.0057	-	48 B
Scriban	String	8,455.09 ns	69.601 ns	287.50	3.6621	0.3052	31003 B
Liquid	String	6,846.45 ns	97.413 ns	232.80	3.9902	0.4044	33418 B
(Utf8.TryWrite)	String	21.79 ns	0.184 ns	0.74	0.0057	-	48 B
(InterpolatedStringHandler)	String	26.39 ns	0.300 ns	0.90	0.0086	-	72 B
(CompositeFormat)	String	26.91 ns	0.230 ns	0.91	0.0086	-	72 B
SimpleTextTemplate.Generator	Int	20.93 ns	0.142 ns	1.00	0.0057	-	48 B
SimpleTextTemplate	Int	56.40 ns	0.185 ns	2.69	0.0057	-	48 B
Scriban	Int	8,439.46 ns	66.766 ns	403.25	3.6621	0.3052	31027 B
Liquid	Int	6,724.20 ns	77.275 ns	321.29	3.9978	0.4425	33442 B
(Utf8.TryWrite)	Int	15.45 ns	0.094 ns	0.74	0.0057	-	48 B
(InterpolatedStringHandler)	Int	28.04 ns	0.181 ns	1.34	0.0076	-	64 B
(CompositeFormat)	Int	32.21 ns	0.330 ns	1.54	0.0076	-	64 B

Note

()で囲まれているメソッドは正確には処理が異なるが、参考として記載。

ベンチマークプロジェクト

サポートフレームワーク

.NET 9

作者

finphie

ライセンス

MIT

クレジット

このプロジェクトでは、次のライブラリ等を使用しています。

ライブラリ

• CommunityToolkit.HighPerformance
• Microsoft.CodeAnalysis.CSharp

テスト

• Microsoft.Testing.Extensions.CodeCoverage
• Shouldly
• xunit.v3

アナライザー

• DocumentationAnalyzers
• IDisposableAnalyzers
• Microsoft.CodeAnalysis.Analyzers
• Microsoft.CodeAnalysis.NetAnalyzers
• Microsoft.VisualStudio.Threading.Analyzers
• Roslynator.Analyzers
• Roslynator.Formatting.Analyzers
• StyleCop.Analyzers

ベンチマーク

• BenchmarkDotNet
• CommandLineParser
• Iced
• Microsoft.CodeAnalysis.CSharp
• Microsoft.Diagnostics.NETCore.Client
• Microsoft.Diagnostics.Runtime
• Microsoft.Diagnostics.Tracing.TraceEvent
• Perfolizer
• Scriban

その他

• PolySharp