Roslyn 语法树中的各种语法节点及每个节点的含义

使用 Roslyn 进行源码分析时,我们会对很多不同种类的语法节点进行分析。如果能够一次性了解到各种不同种类的语法节点,并明白其含义和结构,那么在源码分析的过程中将会更加得心应手。

本文将介绍 Roslyn 中各种不同的语法节点、每个节点的含义,以及这些节点之间的关系和语法树结构。


基本概念

using System;

namespace Walterlv.Demo
{
    class Program
    {
        static void Main(string[] args)
        {
            Console.WriteLine("Hello Walterlv!");
        }
    }
}

以上是一个非常简单但完整的 .cs 文件。

在 Roslyn 的解析中,这就是一个“编译单元”(Compilation Unit)。编译单元是 Roslyn 语法树的根节点。紧接着的 using System 是 using 指令(Using Directives);随后是命名空间声明(Namespace Declaration),包含子节点类型声明(Class Declaration);类型声明包含子节点方法声明(Method Declaration)。

接下来,我们会介绍 Roslyn 语法树中各种不同种类的节点,以及其含义。

语法节点

语法树

CompilationUnit,是语法树的根节点。

关键字

UsingKeywordNamespaceKeywordPublicKeywordInternalKeywordPrivateKeywordProtectedKeywordStaticKeywordClassKeywordInterfaceKeywordStructKeyword

分别是 C# 的各种关键字:using, namespace, public, internal, private, protected, static, class, interface, struct

InKeywordOutKeywordRefKeywordReturnKeywordConstKeywordDefaultKeyword

分别是 C# 的另一波关键字 inoutrefreturnconstdefault

ByteKeywordCharKeywordIntKeywordLongKeywordBoolKeywordFloatKeywordDoubleKeywordDecimalKeyword

分别是 C# 中的基元类型关键字bytecharintlongboolfloatdoubledecimal。需要注意的是,vardynamic 并不是基元类型关键字,在语法节点中,它是 IdentifierName。

AsyncKeywordAwaitKeyword

分别是 asyncawait 关键字。

TrueKeywordFalseKeyword

分别是 truefalse 关键字。

LockKeywordCheckedKeywordUncheckedKeywordUnsafeKeywordFixedKeyword

分别是 lockcheckeduncheckedunsafefixed 关键字。

符号

DotTokenSemicolonTokenOpenBraceTokenCloseBraceTokenLessThanTokenGreaterThanTokenOpenParenTokenCloseParenToken

分别是 C# 中的各种符号:., ;, {, }, <, >, (, )

空白

EndOfLineTrivia 表示换行,WhitespaceTrivia 表示空格,EndOfFileToken 表示文件的末尾。

通常,这两个语法节点会在另一个节点的里面,作为另一个节点的最后一部分。比如 using Walterlv.Demo; 是一个 UsingDirective,它的最后一个节点 Semicolon 中就会包含换行符 EndOfLineTrivia。

指令

UsingDirectiveusing 指令。一个 using 指令包含一个 UsingKeyword,一个 QualifiedName 和一个 Semicolon(;)。

声明

NamespaceDeclarationClassDeclarationMethodDeclarationPropertyDeclarationFieldDeclarationVariableDeclaration

分别是命名空间、类型、方法、属性、。

其中,属性声明包含一个 AccessorList,即属性访问器列表,访问期列表可以包含 GetAccessorDeclaration(属性 get)、SetAccessorDeclaration(属性 set)的声明。

这些声明通常是嵌套存在的。例如一个常规的文件的第 0、1 级语法节点通常是这样的:

类型声明是命名空间声明的子节点,类型成员的声明是类型声明的子节点。

名称和标识符

特性

AttributeListAttribute

一个允许添加特性的地方,如果添加了特性,那么可以得到 AttributeList 节点,内部包含了多个 Attribute 子节点。

形参和实参

形参是 parameter,实参是 argument。前者是定义的参数,后者是实际传入的参数。

语法节点中有两种不同的形参和实参,一个是泛型,一个是普通参数。

语句块

语句

一个语句是指包含分号在内的实际执行的句子。

表达式

基元类型

PredefinedType 是所有基元类型的节点。它的子节点可能是 BoolKeyword、StringKeyword 或其它基元类型的关键字。

C# 内建类型

NullableTypeTupleTypeArrayType

这三个分别是 C# 中语法级别支持的类型,分别是可空类型、元组类型和数组类型。

本文会经常更新,请阅读原文: https://walterlv.github.io/post/roslyn-syntax-tree-nodes.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

知识共享许可协议 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://walterlv.github.io ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系