Added CreateEntireFilePosition methods and allow SourcePosition to be overridden.

Author: MrKWatkins

src/MrKWatkins.Ast.Tests/Position/BinaryFileTests.cs

@@ -55,6 +55,19 @@ public void CreatePosition()
         position.StartIndex.Should().Be(1);
         position.Length.Should().Be(2);
     }
+    
+    [Test]
+    public void CreateEntireFilePosition()
+    {
+        var bytes = new byte[] { 1, 2, 3, 4, 5 };
+        
+        var binaryFile = new BinaryFile("Test Filename", bytes);
+
+        var position = binaryFile.CreateEntireFilePosition();
+        position.File.Should().BeSameAs(binaryFile);
+        position.StartIndex.Should().Be(0);
+        position.Length.Should().Be(5);
+    }
 
     [TestCaseSource(nameof(EqualityTestCases))]
     public void Equality(SourceFile x, object? y, bool expected) => AssertEqual(x, y, expected);

src/MrKWatkins.Ast.Tests/Position/TextFileTests.cs

@@ -64,6 +64,25 @@ public void CreatePosition()
         position.Text.Should().Be("More");
     }
 
+    [Test]
+    public void CreateEntireFilePosition()
+    {
+        const string text = "Some Text\nSome More Text";
+        
+        var textFile = new TextFile("Test Filename", text);
+
+        var position = textFile.CreateEntireFilePosition();
+        position.File.Should().BeSameAs(textFile);
+        position.StartIndex.Should().Be(0);
+        position.Length.Should().Be(24);
+        position.StartLineIndex.Should().Be(0);
+        position.StartLineNumber.Should().Be(1);
+        position.StartColumnIndex.Should().Be(0);
+        position.StartColumnNumber.Should().Be(1);
+        position.StartLine.Should().Be("Some Text");
+        position.Text.Should().Be(text);
+    }
+
     [TestCaseSource(nameof(EqualityTestCases))]
     public void Equality(SourceFile x, object? y, bool expected) => AssertEqual(x, y, expected);
 

src/MrKWatkins.Ast/Node.cs

@@ -28,7 +28,7 @@ protected Node()
     /// <summary>
     /// The position of the node in the source code.
     /// </summary>
-    public SourcePosition SourcePosition
+    public virtual SourcePosition SourcePosition
     {
         get => Properties.GetOrDefault(nameof(SourcePosition), SourcePosition.None);
         set => Properties.Set(nameof(SourcePosition), value);

src/MrKWatkins.Ast/Position/BinaryFile.cs

@@ -51,6 +51,13 @@ public BinaryFile(string name, IReadOnlyList<byte> bytes)
     [Pure]
     public BinaryFilePosition CreatePosition(int startIndex, int length) =>
         new(this, startIndex, length);
+    
+    /// <summary>
+    /// Creates a <see cref="BinaryFilePosition" /> from this <see cref="BinaryFile" /> that represents the whole file.
+    /// </summary>
+    /// <returns>A new <see cref="BinaryFilePosition" /> instance.</returns>
+    [Pure]
+    public BinaryFilePosition CreateEntireFilePosition() => new(this, 0, Length);
 
     [Pure]
     private static IReadOnlyList<byte> ReadStream(Stream stream)

src/MrKWatkins.Ast/Position/TextFile.cs

@@ -52,7 +52,7 @@ public TextFile(string name, string text)
     public IReadOnlyList<string> Lines { get; }
 
     /// <summary>
-    /// Creates a <see cref="TextFilePosition" /> from this <see cref="BinaryFile" />.
+    /// Creates a <see cref="TextFilePosition" /> from this <see cref="TextFile" />.
     /// </summary>
     /// <param name="startIndex">The start index of the position in the file.</param>
     /// <param name="length">The length of the file.</param>
@@ -62,6 +62,13 @@ public TextFile(string name, string text)
     [Pure]
     public TextFilePosition CreatePosition(int startIndex, int length, int startLineIndex, int startColumnIndex) =>
         new(this, startIndex, length, startLineIndex, startColumnIndex);
+    
+    /// <summary>
+    /// Creates a <see cref="TextFilePosition" /> from this <see cref="TextFile" /> that represents the whole file.
+    /// </summary>
+    /// <returns>A new <see cref="TextFilePosition" /> instance.</returns>
+    [Pure]
+    public TextFilePosition CreateEntireFilePosition() => new(this, 0, Length, 0, 0);
 
     [Pure]
     private static string ReadStream(Stream stream)