CSharpier代码生成器揭秘：自动生成语法节点打印器的实现原理-程序员充电站

CSharpier代码生成器揭秘：自动生成语法节点打印器的实现原理

【免费下载链接】csharpierCSharpier is an opinionated code formatter for c#.项目地址: https://gitcode.com/gh_mirrors/cs/csharpier

CSharpier是一款针对C#的代码格式化工具，它通过自动生成语法节点打印器来实现对各种C#语法结构的格式化处理。本文将深入探讨其代码生成器的实现原理，帮助开发者理解这一强大功能背后的技术细节。

核心组件：NodePrinterGenerator类

在CSharpier项目中，语法节点打印器的自动生成主要由NodePrinterGenerator类负责。这个类实现了IIncrementalGenerator接口，能够在编译时增量生成代码。其核心代码位于Src/CSharpier.Generators/NodePrinterGenerator.cs文件中。

特殊语法节点处理

CSharpier需要处理各种C#语法节点，其中一些节点有特殊的语法种类。NodePrinterGenerator类通过一个字典来定义这些特殊情况：

private static readonly Dictionary<string, string[]> SpecialCase = new() { { nameof(AssignmentExpressionSyntax), new[] { nameof(SyntaxKind.SimpleAssignmentExpression), nameof(SyntaxKind.AddAssignmentExpression), // 其他赋值表达式类型... } }, // 其他特殊节点类型... };

这个字典映射了语法节点类型到其对应的语法种类，例如AssignmentExpressionSyntax对应多种赋值操作符类型。

代码生成流程

1. 初始化增量生成器

Initialize方法设置了增量生成的触发条件，当包含"SyntaxNodePrinters"的语法树发生变化时，将触发代码生成：

public void Initialize(IncrementalGeneratorInitializationContext context) { var syntaxTrees = context.CompilationProvider.Select( (compilation, _) => compilation .SyntaxTrees.Where(o => o.FilePath.Contains("SyntaxNodePrinters")) .ToImmutableArray() ); context.RegisterSourceOutput(syntaxTrees, GenerateSource); }

2. 生成源代码

GenerateSource方法是代码生成的核心，它使用Scriban模板引擎来渲染生成代码：

private static void GenerateSource( SourceProductionContext context, ImmutableArray<SyntaxTree> syntaxTrees ) { if (syntaxTrees.Length == 0) { return; } var generator = new NodePrinterGenerator(); var template = Template.Parse(generator.GetContent(generator.GetType().Name + ".sbntxt")); var renderedSource = template.Render( generator.GetModel(syntaxTrees), member => member.Name ); var sourceText = SourceText.From(renderedSource, Encoding.UTF8); context.AddSource("Node", sourceText); }

3. 准备模板数据模型

GetModel方法准备了模板所需的数据，包括节点类型、语法节点名称和对应的语法种类：

private object GetModel(ImmutableArray<SyntaxTree> syntaxTrees) { var nodeTypes = syntaxTrees .Select(o => Path.GetFileNameWithoutExtension(o.FilePath)) .Select(fileName => new { PrinterName = fileName, SyntaxNodeName = $"{fileName}Syntax", SyntaxKinds = SpecialCase.TryGetValue($"{fileName}Syntax", out var kinds) ? string.Join(" or ", kinds.Select(x => $"SyntaxKind.{x}")) : $"SyntaxKind.{fileName}", }) .OrderBy(o => o.SyntaxNodeName) .ToArray(); var syntaxNodeTypes = string.Join(" or ", nodeTypes.Select(x => x.SyntaxNodeName)); return new { NodeTypes = nodeTypes, SyntaxNodeTypes = syntaxNodeTypes }; }

模板驱动的代码生成

CSharpier的代码生成采用模板驱动的方式，使用Scriban模板引擎。虽然我们无法直接查看模板文件NodePrinterGenerator.sbntxt的内容，但从代码中可以看出，它会根据GetModel方法提供的数据模型来生成语法节点打印器的代码。

这种设计使得添加新的语法节点支持变得非常简单，只需添加相应的模板和配置，而无需手动编写大量重复的代码。

其他生成器

除了NodePrinterGenerator，CSharpier项目中还有其他代码生成器，如SyntaxNodeComparerGenerator和SyntaxNodeJsonWriterGenerator，它们分别负责生成语法节点比较器和JSON序列化器的代码。这些生成器遵循类似的实现模式，共同构成了CSharpier强大的代码生成能力。