Add component mapping

Author: jjonescz

src/Compiler/Microsoft.AspNetCore.Razor.Language/src/CodeGeneration/CodeRenderingContext.cs

@@ -37,6 +37,8 @@ public abstract class CodeRenderingContext : IDisposable
 
     public abstract void AddSourceMappingFor(SourceSpan node);
 
+    public abstract void AddComponentMapping(int length);
+
     public abstract void RenderNode(IntermediateNode node);
 
     public abstract void RenderNode(IntermediateNode node, IntermediateNodeWriter writer);

src/Compiler/Microsoft.AspNetCore.Razor.Language/src/CodeGeneration/CodeWriterExtensions.cs

@@ -422,6 +422,7 @@ public static CSharpCodeWritingScope BuildClassDeclaration(
         }
 
         writer.Write("class ");
+        context.AddComponentMapping(name.Length);
         writer.Write(name);
 
         if (typeParameters != null && typeParameters.Count > 0)

src/Compiler/Microsoft.AspNetCore.Razor.Language/src/CodeGeneration/DefaultCodeRenderingContext.cs

@@ -19,6 +19,7 @@ internal class DefaultCodeRenderingContext : CodeRenderingContext
     private readonly List<ScopeInternal> _scopes;
 
     private readonly PooledObject<ImmutableArray<SourceMapping>.Builder> _sourceMappingsBuilder;
+    private readonly PooledObject<ImmutableArray<SourceSpan>.Builder> _componentMappingsBuilder;
 
     public DefaultCodeRenderingContext(
         CodeWriter codeWriter,
@@ -61,6 +62,7 @@ public DefaultCodeRenderingContext(
         Diagnostics = new RazorDiagnosticCollection();
         Items = new ItemCollection();
         _sourceMappingsBuilder = ArrayBuilderPool<SourceMapping>.GetPooledObject();
+        _componentMappingsBuilder = ArrayBuilderPool<SourceSpan>.GetPooledObject();
         LinePragmas = new List<LinePragma>();
 
         var diagnostics = _documentNode.GetAllDiagnostics();
@@ -100,6 +102,8 @@ public DefaultCodeRenderingContext(
 
     public ImmutableArray<SourceMapping>.Builder SourceMappings => _sourceMappingsBuilder.Object;
 
+    public ImmutableArray<SourceSpan>.Builder ComponentMappings => _componentMappingsBuilder.Object;
+
     internal List<LinePragma> LinePragmas { get; }
 
     public override IntermediateNodeWriter NodeWriter => Current.Writer;
@@ -142,6 +146,11 @@ public override void AddSourceMappingFor(SourceSpan source)
         SourceMappings.Add(sourceMapping);
     }
 
+    public override void AddComponentMapping(int length)
+    {
+        ComponentMappings.Add(new SourceSpan(CodeWriter.Location, length));
+    }
+
     public override void RenderChildren(IntermediateNode node)
     {
         if (node == null)
@@ -220,6 +229,7 @@ public override void AddLinePragma(LinePragma linePragma)
     public override void Dispose()
     {
         _sourceMappingsBuilder.Dispose();
+        _componentMappingsBuilder.Dispose();
     }
 
     private struct ScopeInternal

src/Compiler/Microsoft.AspNetCore.Razor.Language/src/CodeGeneration/DefaultDocumentWriter.cs

@@ -53,6 +53,7 @@ public override RazorCSharpDocument WriteDocument(RazorCodeDocument codeDocument
             _options,
             allOrderedDiagnostics.ToArray(),
             context.SourceMappings.DrainToImmutable(),
+            context.ComponentMappings.DrainToImmutable(),
             context.LinePragmas.ToArray());
     }
 

src/Compiler/Microsoft.AspNetCore.Razor.Language/src/DefaultRazorCSharpDocument.cs

@@ -15,6 +15,7 @@ internal class DefaultRazorCSharpDocument : RazorCSharpDocument
     private readonly string _generatedCode;
     private readonly RazorDiagnostic[] _diagnostics;
     private readonly ImmutableArray<SourceMapping> _sourceMappings;
+    private readonly ImmutableArray<SourceSpan> _componentMappings;
     private readonly LinePragma[] _linePragmas;
     private readonly RazorCodeGenerationOptions _options;
     private readonly RazorCodeDocument _codeDocument;
@@ -25,6 +26,7 @@ public DefaultRazorCSharpDocument(
         RazorCodeGenerationOptions options,
         RazorDiagnostic[] diagnostics,
         ImmutableArray<SourceMapping> sourceMappings,
+        ImmutableArray<SourceSpan> componentMappings,
         LinePragma[] linePragmas)
     {
         if (generatedCode == null)
@@ -43,7 +45,9 @@ public DefaultRazorCSharpDocument(
 
         _diagnostics = diagnostics ?? Array.Empty<RazorDiagnostic>();
         _sourceMappings = sourceMappings;
+        _componentMappings = componentMappings;
         _linePragmas = linePragmas ?? Array.Empty<LinePragma>();
+        _componentMappings = componentMappings;
     }
 
     public override IReadOnlyList<RazorDiagnostic> Diagnostics => _diagnostics;
@@ -52,6 +56,8 @@ public DefaultRazorCSharpDocument(
 
     public override ImmutableArray<SourceMapping> SourceMappings => _sourceMappings;
 
+    public override ImmutableArray<SourceSpan> ComponentMappings => _componentMappings;
+
     internal override IReadOnlyList<LinePragma> LinePragmas => _linePragmas;
 
     public override RazorCodeGenerationOptions Options => _options;

src/Compiler/Microsoft.AspNetCore.Razor.Language/src/PublicAPI.Unshipped.txt

@@ -8,6 +8,7 @@
 *REMOVED*~Microsoft.AspNetCore.Razor.Language.TagHelperDescriptor.TagMatchingRules.get -> System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Razor.Language.TagMatchingRuleDescriptor>
 *REMOVED*~Microsoft.AspNetCore.Razor.Language.TagMatchingRuleDescriptor.Attributes.get -> System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Razor.Language.RequiredAttributeDescriptor>
 *REMOVED*~virtual Microsoft.AspNetCore.Razor.Language.BoundAttributeDescriptor.BoundAttributeParameters.get -> System.Collections.Generic.IReadOnlyList<Microsoft.AspNetCore.Razor.Language.BoundAttributeParameterDescriptor>
+abstract Microsoft.AspNetCore.Razor.Language.CodeGeneration.CodeRenderingContext.AddComponentMapping(int length) -> void
 abstract Microsoft.AspNetCore.Razor.Language.CodeGeneration.CodeRenderingContext.AddSourceMappingFor(Microsoft.AspNetCore.Razor.Language.SourceSpan node) -> void
 abstract Microsoft.AspNetCore.Razor.Language.CodeGeneration.CodeRenderingContext.Dispose() -> void
 abstract Microsoft.AspNetCore.Razor.Language.MetadataCollection.ContainsKey(string! key) -> bool
@@ -17,6 +18,7 @@ abstract Microsoft.AspNetCore.Razor.Language.MetadataCollection.Keys.get -> Syst
 abstract Microsoft.AspNetCore.Razor.Language.MetadataCollection.this[string! key].get -> string?
 abstract Microsoft.AspNetCore.Razor.Language.MetadataCollection.TryGetValue(string! key, out string? value) -> bool
 abstract Microsoft.AspNetCore.Razor.Language.MetadataCollection.Values.get -> System.Collections.Generic.IEnumerable<string?>!
+abstract Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument.ComponentMappings.get -> System.Collections.Immutable.ImmutableArray<Microsoft.AspNetCore.Razor.Language.SourceSpan>
 abstract Microsoft.AspNetCore.Razor.Language.RazorSourceDocumentProperties.FilePath.get -> string?
 abstract Microsoft.AspNetCore.Razor.Language.RazorSourceDocumentProperties.RelativePath.get -> string?
 abstract Microsoft.AspNetCore.Razor.Language.TagHelperCollector<T>.Collect(Microsoft.CodeAnalysis.ISymbol! symbol, System.Collections.Generic.ICollection<Microsoft.AspNetCore.Razor.Language.TagHelperDescriptor!>! results) -> void
@@ -365,7 +367,7 @@ virtual Microsoft.AspNetCore.Razor.Language.RazorEnginePhaseBase.OnInitialized()
 ~static Microsoft.AspNetCore.Razor.Language.RazorCodeDocumentExtensions.SetImportSyntaxTrees(this Microsoft.AspNetCore.Razor.Language.RazorCodeDocument document, System.Collections.Immutable.ImmutableArray<Microsoft.AspNetCore.Razor.Language.RazorSyntaxTree> syntaxTrees) -> void
 ~static Microsoft.AspNetCore.Razor.Language.RazorCodeDocumentExtensions.SetPreTagHelperSyntaxTree(this Microsoft.AspNetCore.Razor.Language.RazorCodeDocument document, Microsoft.AspNetCore.Razor.Language.RazorSyntaxTree syntaxTree) -> void
 ~static Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument.Create(Microsoft.AspNetCore.Razor.Language.RazorCodeDocument codeDocument, string generatedCode, Microsoft.AspNetCore.Razor.Language.RazorCodeGenerationOptions options, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Razor.Language.RazorDiagnostic> diagnostics) -> Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument
-~static Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument.Create(Microsoft.AspNetCore.Razor.Language.RazorCodeDocument codeDocument, string generatedCode, Microsoft.AspNetCore.Razor.Language.RazorCodeGenerationOptions options, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Razor.Language.RazorDiagnostic> diagnostics, System.Collections.Immutable.ImmutableArray<Microsoft.AspNetCore.Razor.Language.SourceMapping> sourceMappings, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Razor.Language.CodeGeneration.LinePragma> linePragmas) -> Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument
+~static Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument.Create(Microsoft.AspNetCore.Razor.Language.RazorCodeDocument codeDocument, string generatedCode, Microsoft.AspNetCore.Razor.Language.RazorCodeGenerationOptions options, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Razor.Language.RazorDiagnostic> diagnostics, System.Collections.Immutable.ImmutableArray<Microsoft.AspNetCore.Razor.Language.SourceMapping> sourceMappings, System.Collections.Immutable.ImmutableArray<Microsoft.AspNetCore.Razor.Language.SourceSpan> componentMappings, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Razor.Language.CodeGeneration.LinePragma> linePragmas) -> Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument
 ~static Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument.Create(string generatedCode, Microsoft.AspNetCore.Razor.Language.RazorCodeGenerationOptions options, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Razor.Language.RazorDiagnostic> diagnostics, System.Collections.Immutable.ImmutableArray<Microsoft.AspNetCore.Razor.Language.SourceMapping> sourceMappings, System.Collections.Generic.IEnumerable<Microsoft.AspNetCore.Razor.Language.CodeGeneration.LinePragma> linePragmas) -> Microsoft.AspNetCore.Razor.Language.RazorCSharpDocument
 ~static Microsoft.AspNetCore.Razor.Language.TagHelperDescriptorBuilderExtensions.SetMetadata(this Microsoft.AspNetCore.Razor.Language.TagHelperDescriptorBuilder builder, System.Collections.Generic.KeyValuePair<string, string> pair) -> void
 ~static Microsoft.AspNetCore.Razor.Language.TagHelperDescriptorBuilderExtensions.SetMetadata(this Microsoft.AspNetCore.Razor.Language.TagHelperDescriptorBuilder builder, System.Collections.Generic.KeyValuePair<string, string> pair1, System.Collections.Generic.KeyValuePair<string, string> pair2) -> void

src/Compiler/Microsoft.AspNetCore.Razor.Language/src/RazorCSharpDocument.cs

@@ -17,6 +17,14 @@ public abstract class RazorCSharpDocument : IRazorGeneratedDocument
 
     public abstract ImmutableArray<SourceMapping> SourceMappings { get; }
 
+    /// <summary>
+    /// Maps spans from the generated source to the whole component.
+    /// </summary>
+    /// <remarks>
+    /// Used to map the component class name, so go-to-definition navigates to the .razor file.
+    /// </remarks>
+    public abstract ImmutableArray<SourceSpan> ComponentMappings { get; }
+
     public abstract IReadOnlyList<RazorDiagnostic> Diagnostics { get; }
 
     public abstract RazorCodeGenerationOptions Options { get; }
@@ -31,7 +39,7 @@ public static RazorCSharpDocument Create(string generatedCode, RazorCodeGenerati
 
     [Obsolete("For backwards compatibility only. Use the overload that takes a RazorCodeDocument")]
     public static RazorCSharpDocument Create(string generatedCode, RazorCodeGenerationOptions options, IEnumerable<RazorDiagnostic> diagnostics, ImmutableArray<SourceMapping> sourceMappings, IEnumerable<LinePragma> linePragmas)
-        => Create(codeDocument: null, generatedCode, options, diagnostics, sourceMappings, linePragmas);
+        => Create(codeDocument: null, generatedCode, options, diagnostics, sourceMappings, ImmutableArray<SourceSpan>.Empty, linePragmas);
 
     public static RazorCSharpDocument Create(RazorCodeDocument codeDocument, string generatedCode, RazorCodeGenerationOptions options, IEnumerable<RazorDiagnostic> diagnostics)
     {
@@ -50,7 +58,7 @@ public static RazorCSharpDocument Create(RazorCodeDocument codeDocument, string
             throw new ArgumentNullException(nameof(diagnostics));
         }
 
-        return new DefaultRazorCSharpDocument(codeDocument, generatedCode, options, diagnostics.ToArray(), sourceMappings: ImmutableArray<SourceMapping>.Empty, linePragmas: null);
+        return new DefaultRazorCSharpDocument(codeDocument, generatedCode, options, diagnostics.ToArray(), sourceMappings: ImmutableArray<SourceMapping>.Empty, componentMappings: ImmutableArray<SourceSpan>.Empty, linePragmas: null);
     }
 
     public static RazorCSharpDocument Create(
@@ -59,6 +67,7 @@ public static RazorCSharpDocument Create(
         RazorCodeGenerationOptions options,
         IEnumerable<RazorDiagnostic> diagnostics,
         ImmutableArray<SourceMapping> sourceMappings,
+        ImmutableArray<SourceSpan> componentMappings,
         IEnumerable<LinePragma> linePragmas)
     {
         if (generatedCode == null)
@@ -76,6 +85,6 @@ public static RazorCSharpDocument Create(
             throw new ArgumentNullException(nameof(diagnostics));
         }
 
-        return new DefaultRazorCSharpDocument(codeDocument, generatedCode, options, diagnostics.ToArray(), sourceMappings, linePragmas.ToArray());
+        return new DefaultRazorCSharpDocument(codeDocument, generatedCode, options, diagnostics.ToArray(), sourceMappings, componentMappings, linePragmas.ToArray());
     }
 }