Roslyn - 如何将变量声明语句插入脚本的开头（在使用之后）？

Question

我的目标是解析用户通过 Roslyn 提供的 C# 脚本文件。 假设最终用户提供了如下脚本：

using System;
return "Hello";

我正在寻找一种通用方法，以便在任何给定脚本的最早可能位置插入一些变量初始化语句。 据我了解，这几乎是在最后一个 using 语句之后。

为了这个例子，假设我只需要插入“var xyz = 123;”在最早的位置。因此，在这种情况下，最终结果应该是

using System;
var xyz = 123;
return "Hello";

我该怎么做？

我尝试了以下方法；

Solution solution = new AdhocWorkspace().CurrentSolution;
var project = solution.AddProject("projectName", "assemblyName", LanguageNames.CSharp)
     .WithMetadataReferences(new[] {MetadataReference.CreateFromFile(typeof(object).Assembly.Location) })
     .WithParseOptions(new CSharpParseOptions(kind: Microsoft.CodeAnalysis.SourceCodeKind.Script));

// scriptCode contains the user script input, e.g.:
// using System;
// return "Hello";
Document document = project.AddDocument("SCRIPT-TEMP-DOCUMENT.cs", scriptCode);
var root = document.GetSyntaxRootAsync().Result;

var my_statement = SyntaxFactory.ParseStatement("var xyz = 123;");

// will return the node: "using System;"
var last_using = root.DescendantNodes().Where(x => x is UsingDirectiveSyntax).Last();

var documentEditor = DocumentEditor.CreateAsync(document).Result;
documentEditor.InsertAfter(last_using, my_statement);

// This step will throw an exception:
// An exception of type 'System.InvalidCastException' occurred in System.Core.dll but was not handled in user code
// non-English message, so losely translated --> Additional information:  object of type "Microsoft.CodeAnalysis.CSharp.Syntax.BlockSyntax" cannot be converted to "Microsoft.CodeAnalysis.CSharp.Syntax.UsingDirectiveSyntax"
var newDocument = documentEditor.GetChangedDocument();

当我尝试直接替换时出现同样的问题

root.InsertNodesAfter(last_using, my_statement);

而不是 DocumentEditor。

为什么会失败？我不确定为什么它试图将我的语句转换为 using 指令 ​​- 我只能附加相同类型的节点吗？！

谁能告诉我如何做到最好？

非常感谢！

Answer 1

SyntaxTree tree = CSharpSyntaxTree.ParseText(
    @"using System;
    return 1;", new CSharpParseOptions(LanguageVersion.CSharp6, DocumentationMode.Parse, SourceCodeKind.Script)
);

var root = (CompilationUnitSyntax)tree.GetRoot();
var global = SyntaxFactory.GlobalStatement(SyntaxFactory.ParseStatement("var xyz = 123;"));
root = root.InsertNodesBefore(root.Members.First(), new SyntaxNode[] { global });

InsertNodesBefore 和InsertNodesAfter 在节点列表上工作，因此要在其之前或之后添加的节点必须在列表中，并且要插入的节点必须来自同一类型。

方法的注释提到它（但不是很清楚）

/// <param name="nodeInList">The node to insert after; a descendant of the root node an element of a list member.</param>

如果需要，请查看实际执行替换的 source code。