编译器API(Compiler APIs) 编译器层包含的对象模型与编译器管道每一部分的公开信息相对应,包括语法和语义两部分。编译器层还包含了对编译器单独调用的固定快照,其中包括程序集引用、编译器选项以及源代码文件。针对C#和Visual Basic语言有两种不同的API。两种API大小差不多,但是对每种语言又进行了高度的定制。该层不依赖于Visual Studio组件。 诊断 API作为分析结果的一部分,编译器会产生一组诊断信息,涵盖了从句法、语义、定义赋值的错误到各种警告和诊断信息。编译器 API 层提供一些可扩展的 API 来公开诊断信息,并允许在编译过程中插入自定义的分析器,也可以象 StyleCop 或 FxCop 那样在编译器预定义信息之外生成自定义的诊断信息。以这种方式来生成诊断有个好处,即可以很方便的集成 MSBuild 或 Visual Studio 这些工具,这些工具依赖于诊断信息,以用于体验如基于策略停止生成、在编辑器中显示波浪线并提示代码修复。脚本 API 作为编译器层的一部分,该团队还提供了 宿主(Hosting)/脚本 API 原型以执行代码片段和累积运行时下上文。 REPL 使用这些 API,不过到目前为止无论是 REPL 还是脚本 API 都不是 .NET 编译器平台项目的一部分。在重新引入这些组件前团队还需要审查这些设计。 工作区 API工作区层包含工作区 API,是做代码分析和重构整个解决方案的起点。它协助你将解决方案中的项目信息组织成单一的对象模型, 你可以直接访问编译器层的对象模型,而无需解析文件、配置项或管理项目间的依赖关系。此外,工作区层还提供了一组 API 可用于在如 Visual Studio IDE 宿主环境中实现代码分析与重构工具,包括:查找所有引用、代码格式化、代码生成API等等。 该层不依赖于 Visual Studio 组件。 句法方面(Working with Syntax)编译器API所展示的最基本得数据结构是句法树。这些树展示了源代码的词汇和语法结构。它们有两个重要得目的: 1、允许工具—比如IDE、插件、代码分析工具以及重构—去看和处理用户项目源代码中的语法结构。 2、确保工具—比如重构和IDE—可以以一种自然得方式创建、更改和重排源代码,而不需要直接使用文本编辑器。通过创建和操作树,工具可以简单的创建和重排源代码。 句法树(Syntax Trees)句法树是用于合辑、代码分析、绑定、重构、IDE特性以及代码生成得主要结构。如果没有被识别和归类为许多知名结构语言元素的其中一个,那么没有任何源代码可以被理解。 句法树有三个关键属性。第一个属性是,句法树保存了完整的源信息。意味着句法树含有源文档中得每一条信息、每一个语法结构、每一个词汇记号,以及工作区、注释和预处理指令中的所有。例如,源中准确展示的每一条文字信息就像是输入进行去的一样。当程序未完成或有异常时,通过在句法树中展示跳过和丢失令牌,句法树可以展示源代码中的错误。 这一特点让语法树的第二个属性成为可能。从解析器得到的语法树与被解析的文本之间是完全可相互转换的。从任何一个语法树节点,都可以得到该节点子树的文本表示。这意味着,语法树可以用以构造和编辑源文本。创建树等于隐式创建等效文本,而编辑语法树,根据已存在树的变化做出一个新树,你才算是有效的编辑了文本。
语法树的第三个属性是:语法树是不变的且线程安全的。这意味着所获得的语法树是当前 代码状态的一个快照,且永远不会被改变。这允许多个用户在需要加锁或复制的情况下,以不同的线程在同一时间与同一棵语法树进行交互。因为树是固定不变的并且无法直接修改,通过创建额外的快照,工厂方法可以创建和更改语法树。通过重用底层的节点,这些树将十分高效,因此可以快速重建新版本且只需很少的额外内存。 语法树是名副其实的树形结构,其中非终止元素是其他元素的父元素。每一个语法树都是由节点、令牌和杂项构成。 句法节点(Syntax Nodes)句法节点是句法树的主要元素。这些节点呈现了如声明、语句、子句和表达式。每一类句法节点都是通过继承自SyntaxNode的类来表示的。节点类集是不可扩展的。
句法树中所有的语法节点都是非终止节点,意思是它们可以一直有其他节点作为子节点。作为其他节点的子节点,每一个子节点都可以通过Parent属性获取父节点。因为节点和树是固定不变的,因此节点的父节点从来不会变。树的根节点的父节点是null。 每一个节点都有一个CHildNodes的方法,改方法返回一个源文档中基于自身位置的子节点序列。这个列表不包括任何令牌。每一个节点都有一个Descendant*的方法集合,比如DescendantNodes、DescendantTokens或DescendantTrivia,用于呈现所有该节点所在子树根的节点、令牌或杂项(trivia)的列表。
另外,通过强类型属性每一个语法节点子类可显示所有相同得子节点。例如,一个 BinaryExpressionSyntax节点类有三个标示二进制操作的额外属性:Left、OperatorToken和Right。Left和Right是ExpressionSyntax,OperatorToken类型是SyntaxToken。
一些语法节点有可选子节点。例如,IfStatementSyntax有一个可选的ElseClauseSyntax。如果没有子节点,该属性返回null。 句法令牌(Syntax Tokens)句法令牌是语言语法的终端,是代码的最小语法单位。它们从来都不是其他节点或令牌的父辈。句法令牌由关键词、标示符、文本和标点符号组成。
出于效率的目的,SyntaxToken类型是CLR值类型。但是,不像句法节点,对于混合了属性(依赖于所要表示令牌的种类)的所有令牌只有一种结构。
例如,一个整型文本令牌表示一个数字值。此外,对于令牌所指的原始源文本,文本令牌有一个Value属性用来告诉你怎么准确解码整型值。该属性被记为对象类型,因为它可能是许多原始类型中得一种。 ValueText属性和Value属性一样,是告诉你同样的信息。但是这个属性被定义为String类型。在C#源文本中的一个标示符可能包含Unicode转义字符,但是转义序列句法本身不是标示符名称的构成部分。所以虽然令牌指向的原始文本包含有转义序列,但是ValueText属性却不是。相反,它包含被转义的Unicode字符标示符。 句法杂项(Syntax Trivia)句法杂项是用来表示源文本中那些大量的对于理解代码来说是微不足道部分,比如空白字符、注释和预处理指令。
因为杂项并不是普通语言语法的一部分,而且可能出现在任何两个令牌之间,它们也不作为节点的孩子以包含在语法树中。然而,当实现像重构这种特性以及为了完全忠于原文时它们又很重要,它们又作为语法树的一部分存在。
你可以通过访问一个令牌的前导杂项(LeadingTrivia)或紧随杂项(TrailingTrivia)集合来访问杂项。当源文本被解析后,杂项序列将与令牌关联起来。通常,一个令牌拥有同一行上自身之后下一令牌之前的任何杂项。该行之后的任何杂项都与下一令牌关联。源文件的第一个令牌取得所有初始杂项,并且文件中最后的杂项序列被附加到文件结束令牌,否则宽度为零。 与句法节点和令牌不同,句法杂项没有父节点。不过,因为它们是句法树的一部分且每一个都与令牌关联,你可以通过 Token 属性来访问所关联的令牌。 与句法令牌一样,杂项是值类型。单个SyntaxTrivia被用来描述各种各样的杂项。
区块每个节点、令牌或者是杂项都能找到其在源文本中的位置和所包含的字符数。文本位置用 32 位整数来表示,它是以零为下标的 Unicode 字符索引。一个TextSpan对象是由开始位置和包含的字符数组成,两者都是整数形式。如果TextSpan长度为0,它则指向两个字符中间的位置。每个节点有两个 TextSpan 类型的属性: Span 和 FullSpan。 Span 属性指的是从该节点的子树中第一个令牌开始到最后一个令牌结束的文本区块。这个区块不包含任何前导或紧随的杂项。 FullSpan 属性则包含了该节点的正常区块,再加上任何前导或紧随的杂项。 例如:
上面代码块中用单个垂直竖线(|)括起来的是声明节点的span。它是“throw new Exception("Not right.");”。完整的区块是被双垂直线(||)括起来的部分。它包括与span同样的字符以及与其相关的前导和紧随杂项。 |