删除节点时保持结构化的琐事

本文关键字：结构化 节点 删除 | 更新日期: 2023-09-27 18:00:15

有没有一种简单的方法可以从树中删除SyntaxNode（即方法），但保留结构化的琐事？

在下面的代码中，我想删除方法A:

public class Sample 
{ 
  #region SomeRegion 
  public void MethodA() 
  { 
  }
  #endregion 
}

我使用CSharpSyntaxRewriter来重写SyntaxTree。在VisitMethodDeclaration方法中，我只是为MethodA返回null。这种方法的问题在于，#region标签的StructuredTrivia也被删除了。这是结果：

public class Sample 
{ 
  #endregion 
}

在我的CSharpSyntaxRewriter:

public override SyntaxNode VisitMethodDeclaration(MethodDeclarationSyntax node) 
{ 
   if (...) 
      return null; 
   else 
      return node; 
}

编辑：正如下面的一个答案中所提到的，我可以将SyntaxNode.RemoveNodes与SyntaxRemoveOptions.KeepDirectives选项一起使用。此解决方案有两大缺点：

  1. 我需要知道哪些SyntaxNode类型可以包含此子类型。例如，一个方法可以在Struct、Class、Interface等中声明。。。这意味着我需要在多个位置进行过滤
  2. 我失去了从下到上构建语法树的能力。这在比较SyntaxTree对象时会出现问题。所有对访问者方法的后续调用都已经看到了在"RemoveNodes"方法中创建的新节点。使用SyntaxNode.RemoveNodes方法可以指定SyntaxRemoveOptions.KeepDirective，但CSharpSyntaxRewriter也可以这样做吗

第二版：以下是我要做的一些代码：https://dotnetfiddle.net/1Cg6UZ

删除节点时保持结构化的琐事

当删除节点时，实际上是在删除它的琐事。要保留琐事，需要修改ClassDeclarationSyntax而不是MethodDeclaration。

访问ClassDeclarationSyntax时，您可以通过删除适当的节点来修改类，并使用SyntaxRemoveOptions.KeepTrailingTrivia|SyntaxremovOptions.Keep LeadingTrivia在实际方法定义前后保留注释和区域语句。

public class ClassDeclarationChanger : CSharpSyntaxRewriter
{
    public override SyntaxNode VisitClassDeclaration(ClassDeclarationSyntax node)
    {
        var methods = node.Members.OfType<MethodDeclarationSyntax>();
        if (methods.Any())
        {
            node = node.RemoveNodes(methods, SyntaxRemoveOptions.KeepTrailingTrivia | 
                    SyntaxRemoveOptions.KeepLeadingTrivia);
        }
        return base.VisitClassDeclaration(node);
    }
}

如果您希望首先访问子节点，当然也可以执行base。首先访问ClassDeclaration（节点），然后仅在战后删除方法节点。

另一种方法是返回另一份声明。但是，您不能简单地返回EmptyStatement（因为这将导致异常），而是可以插入一个没有内容的新方法声明：

public class SampleChanger : CSharpSyntaxRewriter
{
    public override SyntaxNode VisitMethodDeclaration(MethodDeclarationSyntax node)
    {
        // Generates a node containing only parenthesis 
        // with no identifier, no return type and no parameters
        var newNode = SyntaxFactory.MethodDeclaration(SyntaxFactory.IdentifierName(""), "");
        // Removes the parenthesis from the Parameter List 
        // and replaces them with MissingTokens
        newNode = newNode.ReplaceNode(newNode.ParameterList,
            newNode.ParameterList.WithOpenParenToken(
                SyntaxFactory.MissingToken(SyntaxKind.OpenParenToken)).
            WithCloseParenToken(SyntaxFactory.MissingToken(SyntaxKind.CloseParenToken)));
        // Returns the new method containing no content 
        // but the Leading and Trailing trivia of the previous node
        return newNode.WithLeadingTrivia(node.GetLeadingTrivia()).
            WithTrailingTrivia(node.GetTrailingTrivia());
    }
}

当然，这种方法的缺点是，它需要针对不同语法类型的特定SyntaxNode，因此在代码的其他部分重用它可能很困难。

我想你正在寻找标志KeepExteriorTrivia如果你检查枚举的源，你会发现他们有一个为预先编译的标志

[Flags]
public enum SyntaxRemoveOptions
{
  KeepNoTrivia = 0,
  KeepLeadingTrivia = 1,
  KeepTrailingTrivia = 2,
  KeepExteriorTrivia = KeepTrailingTrivia | KeepLeadingTrivia,
  KeepUnbalancedDirectives = 4,
  KeepDirectives = 8,
  KeepEndOfLine = 16,
  AddElasticMarker = 32,
}

你的函数调用现在看起来是这样的：

public class ClassDeclarationChanger : CSharpSyntaxRewriter
{
    public override SyntaxNode VisitClassDeclaration(ClassDeclarationSyntax node)
    {
        var methods = node.Members.OfType<MethodDeclarationSyntax>();
        if (methods.Any())
        {
            node = node.RemoveNodes(methods, SyntaxRemoveOptions.KeepExteriorTrivia);
        }
        return base.VisitClassDeclaration(node);
    }
}
相关文章：