Add Range and IsImplicit properties to NodeDebugInfo

Author: desplesda

CHANGELOG.md

@@ -11,6 +11,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 - Added support for variadic functions.
 - Added support for cancelling compilation.
   - To enable cancelling a compilation, supply a `CancellationToken` to your `CompilationJob` object. You can request that the compilation be cancelled by cancelling the token. For more information, see [Task Cancellation](https://learn.microsoft.com/en-us/dotnet/standard/parallel-programming/task-cancellation).
+- Added `NodeDebugInfo.Range`, which contains the range in which a node appears in the source code.
+- Added `NodeDebugInfo.IsImplicit`, which indicates whether the node was created by the compiler (and does not appear in the source code).
 
 ### Changed
 

YarnSpinner.Compiler/DebugInfo.cs

@@ -43,7 +43,7 @@ internal static ProjectDebugInfo Combine(params ProjectDebugInfo[] debugInfos)
     /// </summary>
     public class NodeDebugInfo
     {
-        public NodeDebugInfo(string fileName, string nodeName)
+        public NodeDebugInfo(string? fileName, string nodeName)
         {
             this.FileName = fileName;
             this.NodeName = nodeName;
@@ -52,12 +52,12 @@ public NodeDebugInfo(string fileName, string nodeName)
         /// <summary>
         /// Gets or sets the file that this DebugInfo was produced from.
         /// </summary>
-        internal string FileName { get; private set; }
+        public string? FileName { get; internal set; } = null;
 
         /// <summary>
         /// Gets or sets the node that this DebugInfo was produced from.
         /// </summary>
-        internal string NodeName { get; set; }
+        public string NodeName { get; internal set; }
 
         /// <summary>
         /// Gets or sets the mapping of instruction numbers to <see
@@ -66,8 +66,25 @@ public NodeDebugInfo(string fileName, string nodeName)
         /// </summary>
         internal Dictionary<int, Position> LinePositions { get; set; } = new Dictionary<int, Position>();
 
+        /// <summary>
+        /// The range in the file in which the node appears.
+        /// </summary>
+        public Range Range { get; internal set; } = new Range();
+
         internal IReadOnlyDictionary<int, string> Labels => this.instructionLabels;
 
+        /// <summary>
+        /// Gets or sets a value indicating whether this node was created by the
+        /// compiler.
+        /// </summary>
+        /// <remarks>
+        /// Nodes that exist in a .yarn file have an <see cref="IsImplicit"/>
+        /// value of <see langword="false"/>. Nodes that are generated by the
+        /// compiler include smart variable implementations, and node group
+        /// 'hub' nodes.
+        /// </remarks>
+        public bool IsImplicit { get; internal set; } = false;
+
         private Dictionary<int, string> instructionLabels = new Dictionary<int, string>();
 
         private HashSet<int> instructionsThatAreDestinations = new HashSet<int>();
@@ -133,7 +150,7 @@ public struct LineInfo
             /// The file name of the source that this intruction was produced
             /// from.
             /// </summary>
-            public string FileName;
+            public string? FileName;
 
             /// <summary>
             /// The node name of the source that this intruction was produced

YarnSpinner.Compiler/FileCompiler.cs

@@ -136,7 +136,15 @@ internal FileCompilationResult Compile()
         public override void EnterNode(YarnSpinnerParser.NodeContext context)
         {
             this.CurrentNode = new Node();
-            this.CurrentNodeDebugInfo = new NodeDebugInfo(FileParseResult.Name, "<unknown>");
+            this.CurrentNodeDebugInfo = new NodeDebugInfo(FileParseResult.Name, "<unknown>")
+            {
+                Range = new Range(
+                    context.Start.Line,
+                    context.Start.Column,
+                    context.Stop.Line,
+                    context.Stop.Column + (context.Stop.StopIndex - context.Stop.StartIndex)
+                )
+            };
         }
 
         /// <summary>

YarnSpinner.Compiler/NodeGroupCompiler.cs

@@ -204,6 +204,8 @@ internal IEnumerable<NodeCompilationResult> CompileNodeGroup()
             var hubNodeDebugInfo = new NodeDebugInfo("<generated>", NodeGroupName);
             this.CurrentNode = hubNode;
             this.CurrentNodeDebugInfo = hubNodeDebugInfo;
+            this.CurrentNodeDebugInfo.IsImplicit = true;
+            this.CurrentNodeDebugInfo.FileName = null;
 
             // For each member in the group, add code that registers it as a
             // candidate. We'll also keep track of each instruction that

YarnSpinner.Compiler/SmartVariableCompiler.cs

@@ -43,7 +43,10 @@ public NodeCompilationResult Compile(Declaration decl)
         public NodeCompilationResult Compile(string sourceFileName, string nodeName, YarnSpinnerParser.ExpressionContext? expression)
         {
             this.CurrentNode = new Node();
-            this.CurrentNodeDebugInfo = new NodeDebugInfo(sourceFileName, nodeName);
+            this.CurrentNodeDebugInfo = new NodeDebugInfo(sourceFileName, nodeName)
+            {
+                IsImplicit = true
+            };
 
             this.CurrentNode.Name = nodeName;
             this.CurrentNode.Headers.Add(new Header { Key = "tags", Value = Program.SmartVariableNodeTag });
@@ -55,6 +58,8 @@ public NodeCompilationResult Compile(string sourceFileName, string nodeName, Yar
                 // empty node with the appropriate tags.
                 var codeGenerator = new CodeGenerationVisitor(this);
                 codeGenerator.Visit(expression);
+
+                this.CurrentNodeDebugInfo.Range = new Range(expression.Start.Line, expression.Start.Column, expression.Stop.Line, expression.Stop.Column);
             }
 
             return new NodeCompilationResult

YarnSpinner.Tests/LanguageTests.cs

@@ -678,6 +678,64 @@ string GenerateExampleSource(int expressions)
             withCancelling.Elapsed.Should().BeLessThan(withoutCancelling.Elapsed,
                 "cancelling a compilation should complete sooner than letting the compilation run to completion");
         }
+
+        [Fact]
+        public void TestNodeDebugInfoContainsInfo()
+        {
+            // Given
+            var source = @"title: NodeA
+---
+Line 1
+Line 2
+<<declare $smartVar = 1+1>>
+===
+title: NodeB
+---
+Line 3
+===
+title: NodeGroup
+when: always
+---
+Line in a node group
+===
+";
+
+
+            // When
+            var compilationJob = CompilationJob.CreateFromString("input", source);
+            var result = Compiler.Compile(compilationJob);
+
+            // Then
+            result.ProjectDebugInfo.Nodes.Should().HaveCount(6);
+
+            var nodeAInfo = result.ProjectDebugInfo.GetNodeDebugInfo("NodeA");
+            var nodeBInfo = result.ProjectDebugInfo.GetNodeDebugInfo("NodeB");
+            var smartVarInfo = result.ProjectDebugInfo.GetNodeDebugInfo("$smartVar");
+            var nodeGroupHub = result.ProjectDebugInfo.GetNodeDebugInfo("NodeGroup");
+            var nodeGroupItem = result.ProjectDebugInfo.Nodes.FirstOrDefault(n => n.NodeName.StartsWith("NodeGroup_"));
+            var nodeGroupItemCondition = result.ProjectDebugInfo.Nodes.FirstOrDefault(n => n.NodeName.Contains(".Condition."));
+
+            nodeAInfo.Should().NotBeNull();
+            nodeBInfo.Should().NotBeNull();
+            smartVarInfo.Should().NotBeNull();
+            nodeGroupHub.Should().NotBeNull();
+            nodeGroupItem.Should().NotBeNull();
+            nodeGroupItemCondition.Should().NotBeNull();
+
+            new[] { nodeAInfo, nodeBInfo, smartVarInfo }.Should().AllSatisfy(i => i.FileName.Should().Be("input"));
+            nodeAInfo.Range.Should().BeEquivalentTo<Yarn.Compiler.Range>(new(1, 0, 6, 2));
+            nodeBInfo.Range.Should().BeEquivalentTo<Yarn.Compiler.Range>(new(7, 0, 10, 2));
+            smartVarInfo.Range.Should().BeEquivalentTo<Yarn.Compiler.Range>(new(5, 22, 5, 24),
+                "the position of the smart variable 'node' is defined by the expression");
+
+            nodeAInfo.IsImplicit.Should().BeFalse();
+            nodeBInfo.IsImplicit.Should().BeFalse();
+            smartVarInfo.IsImplicit.Should().BeTrue();
+
+            nodeGroupHub.IsImplicit.Should().BeTrue("node group hubs are created by the compiler and do not appear in the input source code");
+            nodeGroupItem.IsImplicit.Should().BeFalse("nodes in a node group are present in the input source code");
+            nodeGroupItemCondition.IsImplicit.Should().BeTrue("node group condition smart variables are created by the compiler");
+        }
     }
 }