Add DirectiveDescriptor to syntax model and remove from annotations

In addition to the mechanical work of transitioning from annotations to the syntax model, I added a handful of helpers to RazorDirectiveSyntax and used them throughout tooling layer.

Author: DustinCampbell

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/DefaultDirectiveSyntaxTreePass.cs

@@ -69,7 +69,7 @@ public override SyntaxNode VisitRazorDirective(RazorDirectiveSyntax node)
         {
             _cancellationToken.ThrowIfCancellationRequested();
 
-            if (node.DirectiveDescriptor?.Directive != SectionDirective.Directive.Directive)
+            if (!node.IsDirective(SectionDirective.Directive))
             {
                 // We only want to track the nesting of section directives.
                 return base.VisitRazorDirective(node);

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Legacy/CSharpCodeParser.cs

@@ -1900,11 +1900,10 @@ RazorDirectiveSyntax BuildDirective(SyntaxKind expectedTokenKindIfMissing)
                 var directiveCodeBlock = SyntaxFactory.CSharpCodeBlock(directiveBuilder.ToList());
 
                 var directiveBody = SyntaxFactory.RazorDirectiveBody(keywordBlock, directiveCodeBlock);
-                var directive = SyntaxFactory.RazorDirective(transition, directiveBody);
+                var directive = SyntaxFactory.RazorDirective(transition, directiveBody, descriptor);
 
                 var diagnostics = directiveErrorSink.GetErrorsAndClear();
                 directive = directive.WithDiagnosticsGreen(diagnostics);
-                directive = directive.WithDirectiveDescriptor(descriptor);
                 return directive;
             }
         }

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/NamespaceComputer.cs

@@ -247,7 +247,7 @@ public override void VisitRazorDirective(RazorDirectiveSyntax node)
         {
             Debug.Assert(_source != null);
 
-            if (node.DirectiveDescriptor == NamespaceDirective.Directive &&
+            if (node.IsDirective(NamespaceDirective.Directive) &&
                 node.Body is RazorDirectiveBodySyntax { CSharpCode.Children: [_, CSharpSyntaxNode @namespace, ..] })
             {
                 _lastNamespaceName = @namespace.GetContent();

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Syntax/Generated/Syntax.xml.Internal.Generated.cs

@@ -3147,29 +3147,33 @@ internal sealed partial class RazorDirectiveSyntax : CSharpRazorBlockSyntax
 {
     internal readonly CSharpTransitionSyntax _transition;
     internal readonly CSharpSyntaxNode _body;
+    internal readonly DirectiveDescriptor _directiveDescriptor;
 
-    internal RazorDirectiveSyntax(SyntaxKind kind, CSharpTransitionSyntax transition, CSharpSyntaxNode body, RazorDiagnostic[] diagnostics, SyntaxAnnotation[] annotations)
+    internal RazorDirectiveSyntax(SyntaxKind kind, CSharpTransitionSyntax transition, CSharpSyntaxNode body, DirectiveDescriptor directiveDescriptor, RazorDiagnostic[] diagnostics, SyntaxAnnotation[] annotations)
         : base(kind, diagnostics, annotations)
     {
         SlotCount = 2;
         AdjustFlagsAndWidth(transition);
         _transition = transition;
         AdjustFlagsAndWidth(body);
         _body = body;
+        _directiveDescriptor = directiveDescriptor;
     }
 
-    internal RazorDirectiveSyntax(SyntaxKind kind, CSharpTransitionSyntax transition, CSharpSyntaxNode body)
+    internal RazorDirectiveSyntax(SyntaxKind kind, CSharpTransitionSyntax transition, CSharpSyntaxNode body, DirectiveDescriptor directiveDescriptor)
         : base(kind)
     {
         SlotCount = 2;
         AdjustFlagsAndWidth(transition);
         _transition = transition;
         AdjustFlagsAndWidth(body);
         _body = body;
+        _directiveDescriptor = directiveDescriptor;
     }
 
     public override CSharpTransitionSyntax Transition => _transition;
     public override CSharpSyntaxNode Body => _body;
+    public DirectiveDescriptor DirectiveDescriptor => _directiveDescriptor;
 
     internal override GreenNode GetSlot(int index)
         => index switch
@@ -3184,11 +3188,11 @@ internal override GreenNode GetSlot(int index)
     public override TResult Accept<TResult>(SyntaxVisitor<TResult> visitor) => visitor.VisitRazorDirective(this);
     public override void Accept(SyntaxVisitor visitor) => visitor.VisitRazorDirective(this);
 
-    public RazorDirectiveSyntax Update(CSharpTransitionSyntax transition, CSharpSyntaxNode body)
+    public RazorDirectiveSyntax Update(CSharpTransitionSyntax transition, CSharpSyntaxNode body, DirectiveDescriptor directiveDescriptor)
     {
         if (transition != Transition || body != Body)
         {
-            var newNode = SyntaxFactory.RazorDirective(transition, body);
+            var newNode = SyntaxFactory.RazorDirective(transition, body, directiveDescriptor);
             var diags = GetDiagnostics();
             if (diags != null && diags.Length > 0)
                 newNode = newNode.WithDiagnosticsGreen(diags);
@@ -3202,10 +3206,10 @@ public RazorDirectiveSyntax Update(CSharpTransitionSyntax transition, CSharpSynt
     }
 
     internal override GreenNode SetDiagnostics(RazorDiagnostic[] diagnostics)
-        => new RazorDirectiveSyntax(Kind, _transition, _body, diagnostics, GetAnnotations());
+        => new RazorDirectiveSyntax(Kind, _transition, _body, _directiveDescriptor, diagnostics, GetAnnotations());
 
     internal override GreenNode SetAnnotations(SyntaxAnnotation[] annotations)
-        => new RazorDirectiveSyntax(Kind, _transition, _body, GetDiagnostics(), annotations);
+        => new RazorDirectiveSyntax(Kind, _transition, _body, _directiveDescriptor, GetDiagnostics(), annotations);
 }
 
 internal sealed partial class RazorDirectiveBodySyntax : CSharpSyntaxNode
@@ -3484,7 +3488,7 @@ public override GreenNode VisitCSharpImplicitExpressionBody(CSharpImplicitExpres
         => node.Update((CSharpCodeBlockSyntax)Visit(node.CSharpCode));
 
     public override GreenNode VisitRazorDirective(RazorDirectiveSyntax node)
-        => node.Update((CSharpTransitionSyntax)Visit(node.Transition), (CSharpSyntaxNode)Visit(node.Body));
+        => node.Update((CSharpTransitionSyntax)Visit(node.Transition), (CSharpSyntaxNode)Visit(node.Body), node.DirectiveDescriptor);
 
     public override GreenNode VisitRazorDirectiveBody(RazorDirectiveBodySyntax node)
         => node.Update((RazorSyntaxNode)Visit(node.Keyword), (CSharpCodeBlockSyntax)Visit(node.CSharpCode));
@@ -3871,12 +3875,12 @@ public static CSharpImplicitExpressionBodySyntax CSharpImplicitExpressionBody(CS
         return result;
     }
 
-    public static RazorDirectiveSyntax RazorDirective(CSharpTransitionSyntax transition, CSharpSyntaxNode body)
+    public static RazorDirectiveSyntax RazorDirective(CSharpTransitionSyntax transition, CSharpSyntaxNode body, DirectiveDescriptor directiveDescriptor)
     {
         ArgHelper.ThrowIfNull(transition);
         ArgHelper.ThrowIfNull(body);
 
-        var result = new RazorDirectiveSyntax(SyntaxKind.RazorDirective, transition, body);
+        var result = new RazorDirectiveSyntax(SyntaxKind.RazorDirective, transition, body, directiveDescriptor);
 
         return result;
     }

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Syntax/Generated/Syntax.xml.Main.Generated.cs

@@ -369,7 +369,7 @@ public override SyntaxNode VisitCSharpImplicitExpressionBody(CSharpImplicitExpre
         => node.Update((CSharpCodeBlockSyntax)Visit(node.CSharpCode));
 
     public override SyntaxNode VisitRazorDirective(RazorDirectiveSyntax node)
-        => node.Update((CSharpTransitionSyntax)Visit(node.Transition), (CSharpSyntaxNode)Visit(node.Body));
+        => node.Update((CSharpTransitionSyntax)Visit(node.Transition), (CSharpSyntaxNode)Visit(node.Body), node.DirectiveDescriptor);
 
     public override SyntaxNode VisitRazorDirectiveBody(RazorDirectiveBodySyntax node)
         => node.Update((RazorSyntaxNode)Visit(node.Keyword), (CSharpCodeBlockSyntax)Visit(node.CSharpCode));
@@ -796,13 +796,17 @@ public static CSharpImplicitExpressionBodySyntax CSharpImplicitExpressionBody()
         => SyntaxFactory.CSharpImplicitExpressionBody(SyntaxFactory.CSharpCodeBlock());
 
     /// <summary>Creates a new RazorDirectiveSyntax instance.</summary>
-    public static RazorDirectiveSyntax RazorDirective(CSharpTransitionSyntax transition, CSharpSyntaxNode body)
+    public static RazorDirectiveSyntax RazorDirective(CSharpTransitionSyntax transition, CSharpSyntaxNode body, DirectiveDescriptor directiveDescriptor)
     {
         ArgHelper.ThrowIfNull(transition);
         ArgHelper.ThrowIfNull(body);
-        return (RazorDirectiveSyntax)InternalSyntax.SyntaxFactory.RazorDirective(transition == null ? null : (InternalSyntax.CSharpTransitionSyntax)transition.Green, body == null ? null : (InternalSyntax.CSharpSyntaxNode)body.Green).CreateRed();
+        return (RazorDirectiveSyntax)InternalSyntax.SyntaxFactory.RazorDirective(transition == null ? null : (InternalSyntax.CSharpTransitionSyntax)transition.Green, body == null ? null : (InternalSyntax.CSharpSyntaxNode)body.Green, directiveDescriptor).CreateRed();
     }
 
+    /// <summary>Creates a new RazorDirectiveSyntax instance.</summary>
+    public static RazorDirectiveSyntax RazorDirective(CSharpTransitionSyntax transition, CSharpSyntaxNode body)
+        => SyntaxFactory.RazorDirective(transition, body, default(DirectiveDescriptor));
+
     /// <summary>Creates a new RazorDirectiveBodySyntax instance.</summary>
     public static RazorDirectiveBodySyntax RazorDirectiveBody(RazorSyntaxNode keyword, CSharpCodeBlockSyntax csharpCode)
     {

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Syntax/Generated/Syntax.xml.Syntax.Generated.cs

@@ -2168,6 +2168,7 @@ internal RazorDirectiveSyntax(GreenNode green, SyntaxNode parent, int position)
 
     public override CSharpTransitionSyntax Transition  => GetRedAtZero(ref _transition);
     public override CSharpSyntaxNode Body  => GetRed(ref _body, 1);
+    public DirectiveDescriptor DirectiveDescriptor => ((InternalSyntax.RazorDirectiveSyntax)Green).DirectiveDescriptor;
 
     internal override SyntaxNode GetNodeSlot(int index)
         => index switch
@@ -2188,11 +2189,11 @@ internal override SyntaxNode GetCachedSlot(int index)
     public override TResult Accept<TResult>(SyntaxVisitor<TResult> visitor) => visitor.VisitRazorDirective(this);
     public override void Accept(SyntaxVisitor visitor) => visitor.VisitRazorDirective(this);
 
-    public RazorDirectiveSyntax Update(CSharpTransitionSyntax transition, CSharpSyntaxNode body)
+    public RazorDirectiveSyntax Update(CSharpTransitionSyntax transition, CSharpSyntaxNode body, DirectiveDescriptor directiveDescriptor)
     {
-        if (transition != Transition || body != Body)
+        if (transition != Transition || body != Body || directiveDescriptor != DirectiveDescriptor)
         {
-            var newNode = SyntaxFactory.RazorDirective(transition, body);
+            var newNode = SyntaxFactory.RazorDirective(transition, body, directiveDescriptor);
             var diagnostics = GetDiagnostics();
             if (diagnostics != null && diagnostics.Length > 0)
                 newNode = newNode.WithDiagnostics(diagnostics);
@@ -2204,9 +2205,10 @@ public RazorDirectiveSyntax Update(CSharpTransitionSyntax transition, CSharpSynt
     }
 
     internal override CSharpRazorBlockSyntax WithTransitionCore(CSharpTransitionSyntax transition) => WithTransition(transition);
-    public new RazorDirectiveSyntax WithTransition(CSharpTransitionSyntax transition) => Update(transition, Body);
+    public new RazorDirectiveSyntax WithTransition(CSharpTransitionSyntax transition) => Update(transition, Body, DirectiveDescriptor);
     internal override CSharpRazorBlockSyntax WithBodyCore(CSharpSyntaxNode body) => WithBody(body);
-    public new RazorDirectiveSyntax WithBody(CSharpSyntaxNode body) => Update(Transition, body);
+    public new RazorDirectiveSyntax WithBody(CSharpSyntaxNode body) => Update(Transition, body, DirectiveDescriptor);
+    public RazorDirectiveSyntax WithDirectiveDescriptor(DirectiveDescriptor directiveDescriptor) => Update(Transition, Body, directiveDescriptor);
 }
 
 internal sealed partial class RazorDirectiveBodySyntax : CSharpSyntaxNode

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Syntax/InternalSyntax/RazorDirectiveSyntax.cs

@@ -30,4 +30,7 @@ public static CSharpTransitionSyntax CSharpTransition(SyntaxToken transition)
 
     public static MarkupTextLiteralSyntax MarkupTextLiteral(SyntaxList<SyntaxToken> literalTokens)
         => MarkupTextLiteral(literalTokens, chunkGenerator: null, editHandler: null);
+
+    public static RazorDirectiveSyntax RazorDirective(CSharpTransitionSyntax transition, CSharpSyntaxNode body)
+        => RazorDirective(transition, body, directiveDescriptor: null);
 }

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Syntax/InternalSyntax/SyntaxFactory.cs

@@ -1,27 +1,21 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-#nullable disable
+using System.Diagnostics.CodeAnalysis;
 
 namespace Microsoft.AspNetCore.Razor.Language.Syntax;
 
 internal sealed partial class RazorDirectiveSyntax
 {
-    private static readonly string DirectiveDescriptorKey = typeof(DirectiveDescriptor).Name;
+    [MemberNotNullWhen(true, nameof(DirectiveDescriptor))]
+    public bool HasDirectiveDescriptor
+        => DirectiveDescriptor is not null;
 
-    public DirectiveDescriptor DirectiveDescriptor
-    {
-        get
-        {
-            var descriptor = this.GetAnnotationValue(DirectiveDescriptorKey) as DirectiveDescriptor;
-            return descriptor;
-        }
-    }
+    [MemberNotNullWhen(true, nameof(DirectiveDescriptor))]
+    public bool IsDirective(DirectiveDescriptor directive)
+        => DirectiveDescriptor == directive;
 
-    public RazorDirectiveSyntax WithDirectiveDescriptor(DirectiveDescriptor descriptor)
-    {
-        var newGreen = Green.WithAnnotationsGreen([.. GetAnnotations(), new(DirectiveDescriptorKey, descriptor)]);
-
-        return (RazorDirectiveSyntax)newGreen.CreateRed(Parent, Position);
-    }
+    [MemberNotNullWhen(true, nameof(DirectiveDescriptor))]
+    public bool IsDirectiveKind(DirectiveKind kind)
+        => DirectiveDescriptor?.Kind == kind;
 }

src/Compiler/Microsoft.CodeAnalysis.Razor.Compiler/src/Language/Syntax/RazorDirectiveSyntax.cs

@@ -383,6 +383,7 @@
     <Field Name="Body" Type="CSharpSyntaxNode" Override="true">
       <Kind Name="RazorDirectiveBody" />
     </Field>
+    <Field Name="DirectiveDescriptor" Type="DirectiveDescriptor" Optional="true" />
   </Node>
   <Node Name="RazorDirectiveBodySyntax" Base="CSharpSyntaxNode">
     <Kind Name="RazorDirectiveBody" />