AddedSourceRange and SourcePosition (#297)

Resolves issues #293, #291 and #290

This involved modifications to any source files that used the "old" SourceLocation.

Author: smaillet

src/Samples/Kaleidoscope/Chapter9/CodeGenerator.cs

@@ -512,8 +512,8 @@ private void EmitLocation( IAstNode? node )
             if(scope != null)
             {
                 loc = new DILocation( InstructionBuilder.Context
-                                    , (uint)(node?.Location.StartLine ?? 0)
-                                    , (uint)(node?.Location.StartColumn ?? 0)
+                                    , (uint)(node?.Location.Start.Line ?? 0)
+                                    , (uint)(node?.Location.Start.Column ?? 0)
                                     , scope
                                     );
             }
@@ -561,11 +561,11 @@ private Function GetOrDeclareFunction( Prototype prototype )
                                               , name: prototype.Name
                                               , linkageName: null
                                               , file: debugFile
-                                              , line: (uint)prototype.Location.StartLine
+                                              , line: (uint)prototype.Location.Start.Line
                                               , signature
                                               , isLocalToUnit: false
                                               , isDefinition: true
-                                              , scopeLine: (uint)lastParamLocation.EndLine
+                                              , scopeLine: (uint)lastParamLocation.End.Line
                                               , debugFlags: prototype.IsCompilerGenerated ? DebugInfoFlags.Artificial : DebugInfoFlags.Prototyped
                                               , isOptimized: false
                                               );
@@ -590,8 +590,8 @@ private void AddDebugInfoForAlloca( Alloca argSlot, Function function, Parameter
         {
             Debug.Assert( CurrentDIBuilder is not null, "Internal error CurrentDIBuilder should be set in Generate already" );
 
-            uint line = ( uint )param.Location.StartLine;
-            uint col = ( uint )param.Location.StartColumn;
+            uint line = ( uint )param.Location.Start.Line;
+            uint col = ( uint )param.Location.Start.Column;
 
             // Keep compiler happy on null checks by asserting on expectations
             // The items were created in this file with all necessary info so
@@ -620,8 +620,8 @@ private void AddDebugInfoForAlloca( Alloca argSlot, Function function, LocalVari
         {
             Debug.Assert( CurrentDIBuilder is not null, "Internal error CurrentDIBuilder should be set in Generate already" );
 
-            uint line = ( uint )localVar.Location.StartLine;
-            uint col = ( uint )localVar.Location.StartColumn;
+            uint line = ( uint )localVar.Location.Start.Line;
+            uint col = ( uint )localVar.Location.Start.Column;
 
             // Keep compiler happy on null checks by asserting on expectations
             // The items were created in this file with all necessary info so

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/ANTLR/KaleidoscopeParser.BinaryPrototypeContext.cs

@@ -20,8 +20,8 @@ internal partial class BinaryPrototypeContext
         {
             public IToken OpToken => userdefinedop().Start;
 
-            public override IEnumerable<(string Name, int Index, SourceLocation Span)> Parameters
-                => Identifier().Select( ( id, i ) => (id.GetText(), i, id.GetSourceLocation()) );
+            public override IEnumerable<(string Name, int Index, SourceRange Span)> Parameters
+                => Identifier().Select( ( id, i ) => (id.GetText(), i, id.GetSourceRange()) );
 
             public int Precedence => (int)double.Parse( Number().GetText(), CultureInfo.InvariantCulture );
         }

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/ANTLR/KaleidoscopeParser.FunctionPrototypeContext.cs

@@ -15,8 +15,8 @@ internal partial class FunctionPrototypeContext
         {
             public override string Name => Identifier( 0 ).GetText();
 
-            public override IEnumerable<(string Name, int Index, SourceLocation Span)> Parameters
-                => Identifier().Skip( 1 ).Select( ( id, i ) => (id.GetText(), i, id.GetSourceLocation()) );
+            public override IEnumerable<(string Name, int Index, SourceRange Span)> Parameters
+                => Identifier().Skip( 1 ).Select( ( id, i ) => (id.GetText(), i, id.GetSourceRange()) );
         }
     }
 }

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/ANTLR/KaleidoscopeParser.PrototypeContext.cs

@@ -13,8 +13,8 @@ internal partial class KaleidoscopeParser
         // base type for all prototypes (technically abstract, but the generator doesn't apply that)
         internal partial class PrototypeContext
         {
-            public virtual IEnumerable<(string Name, int Index, SourceLocation Span)> Parameters
-                => Enumerable.Empty<(string, int, SourceLocation)>();
+            public virtual IEnumerable<(string Name, int Index, SourceRange Span)> Parameters
+                => Enumerable.Empty<(string, int, SourceRange)>();
 
             public virtual string Name => string.Empty;
         }

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/ANTLR/KaleidoscopeParser.UnaryPrototypeContext.cs

@@ -14,11 +14,11 @@ internal partial class KaleidoscopeParser
     {
         internal partial class UnaryPrototypeContext
         {
-            public override IEnumerable<(string Name, int Index, SourceLocation Span)> Parameters
+            public override IEnumerable<(string Name, int Index, SourceRange Span)> Parameters
             {
                 get
                 {
-                    yield return (Identifier().GetText(), 0, Identifier().GetSourceLocation());
+                    yield return (Identifier().GetText(), 0, Identifier().GetSourceRange());
                 }
             }
 

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/AST/AstBuilder.cs

@@ -26,7 +26,7 @@ public AstBuilder( DynamicRuntimeState globalState )
 
         public override IAstNode VisitErrorNode( IErrorNode node )
         {
-            return new ErrorNode( node.GetSourceLocation(), $"Syntax Error: {node}" );
+            return new ErrorNode( node.GetSourceRange(), $"Syntax Error: {node}" );
         }
 
         public override IAstNode VisitParenExpression( ParenExpressionContext context )
@@ -36,23 +36,23 @@ public override IAstNode VisitParenExpression( ParenExpressionContext context )
 
         public override IAstNode VisitConstExpression( ConstExpressionContext context )
         {
-            return new ConstantExpression( context.GetSourceLocation(), context.Value );
+            return new ConstantExpression( context.GetSourceRange(), context.Value );
         }
 
         public override IAstNode VisitVariableExpression( VariableExpressionContext context )
         {
             string varName = context.Name;
             return NamedValues.TryGetValue( varName, out IVariableDeclaration? declaration )
-                ? new VariableReferenceExpression( context.GetSourceLocation(), declaration )
-                : new ErrorNode( context.GetSourceLocation(), $"Unknown variable name: {varName}" );
+                ? new VariableReferenceExpression( context.GetSourceRange(), declaration )
+                : new ErrorNode( context.GetSourceRange(), $"Unknown variable name: {varName}" );
         }
 
         public override IAstNode VisitFunctionCallExpression( FunctionCallExpressionContext context )
         {
             Prototype? function = FindCallTarget( context.CaleeName );
             if(function is null)
             {
-                return new ErrorNode( context.GetSourceLocation(), $"Call to unknown function '{context.CaleeName}'" );
+                return new ErrorNode( context.GetSourceRange(), $"Call to unknown function '{context.CaleeName}'" );
             }
 
             var argNodes = ( from expCtx in context.expression( )
@@ -67,7 +67,7 @@ select expCtx.Accept( this )
                 }
             }
 
-            return new FunctionCallExpression( context.GetSourceLocation(), function, argNodes.Cast<IExpression>() );
+            return new FunctionCallExpression( context.GetSourceRange(), function, argNodes.Cast<IExpression>() );
         }
 
         public override IAstNode VisitExpression( ExpressionContext context )
@@ -126,7 +126,7 @@ public override IAstNode VisitFunctionDefinition( FunctionDefinitionContext cont
                 return body;
             }
 
-            var retVal = new FunctionDefinition( context.GetSourceLocation( )
+            var retVal = new FunctionDefinition( context.GetSourceRange( )
                                                , sig
                                                , exp
                                                , LocalVariables.ToImmutableArray( )
@@ -150,7 +150,7 @@ public override IAstNode VisitFunctionDefinition( FunctionDefinitionContext cont
         public override IAstNode VisitTopLevelExpression( TopLevelExpressionContext context )
         {
             BeginFunctionDefinition();
-            var sig = new Prototype( context.GetSourceLocation( ), RuntimeState.GenerateAnonymousName( ), true );
+            var sig = new Prototype( context.GetSourceRange( ), RuntimeState.GenerateAnonymousName( ), true );
             var bodyNode = context.expression( ).Accept( this );
             var errors = bodyNode.CollectErrors();
 
@@ -160,7 +160,7 @@ public override IAstNode VisitTopLevelExpression( TopLevelExpressionContext cont
                 return bodyNode;
             }
 
-            var retVal = new FunctionDefinition( context.GetSourceLocation( ), sig, bodyExp, true );
+            var retVal = new FunctionDefinition( context.GetSourceRange( ), sig, bodyExp, true );
             RuntimeState.FunctionDefinitions.AddOrReplaceItem( retVal );
             return retVal;
         }
@@ -172,18 +172,18 @@ public override IAstNode VisitUnaryOpExpression( UnaryOpExpressionContext contex
             var opKind = RuntimeState.GetUnaryOperatorInfo( context.Op ).Kind;
             if(opKind == OperatorKind.None)
             {
-                return new ErrorNode( context.GetSourceLocation(), $"invalid unary operator {context.Op}" );
+                return new ErrorNode( context.GetSourceRange(), $"invalid unary operator {context.Op}" );
             }
 
             string calleeName = CreateUnaryFunctionName( context.OpToken );
             var function = FindCallTarget( calleeName );
             if(function == null)
             {
-                return new ErrorNode( context.GetSourceLocation(), $"reference to unknown unary operator function {calleeName}" );
+                return new ErrorNode( context.GetSourceRange(), $"reference to unknown unary operator function {calleeName}" );
             }
 
             var arg = context.Rhs.Accept( this );
-            return arg is not IExpression exp ? arg : new FunctionCallExpression( context.GetSourceLocation(), function, exp );
+            return arg is not IExpression exp ? arg : new FunctionCallExpression( context.GetSourceRange(), function, exp );
         }
         #endregion
 
@@ -193,12 +193,12 @@ public override IAstNode VisitFullsrc( FullsrcContext context )
                            where child is not TopLevelSemicolonContext
                            select child.Accept( this );
 
-            return new RootNode( context.GetSourceLocation(), children );
+            return new RootNode( context.GetSourceRange(), children );
         }
 
         public override IAstNode VisitConditionalExpression( ConditionalExpressionContext context )
         {
-            var expressionSpan = context.GetSourceLocation( );
+            var expressionSpan = context.GetSourceRange( );
             var condition = context.Condition.Accept( this );
             if(condition is not IExpression conditionExp)
             {
@@ -258,7 +258,7 @@ public override IAstNode VisitForExpression( ForExpressionContext context )
                     return bodyNode;
                 }
 
-                retVal = new ForInExpression( context.GetSourceLocation(), initializer, conditionExp, stepExp, bodyExp );
+                retVal = new ForInExpression( context.GetSourceRange(), initializer, conditionExp, stepExp, bodyExp );
             }
 
             return retVal;
@@ -277,7 +277,7 @@ public override IAstNode VisitVarInExpression( VarInExpressionContext context )
                 }
 
                 var bodyNode = context.Scope.Accept( this );
-                return bodyNode is not IExpression bodyExp ? bodyNode : new VarInExpression( context.GetSourceLocation(), localVariables, bodyExp );
+                return bodyNode is not IExpression bodyExp ? bodyNode : new VarInExpression( context.GetSourceRange(), localVariables, bodyExp );
             }
         }
 
@@ -288,8 +288,8 @@ public override IAstNode VisitFunctionPrototype( FunctionPrototypeContext contex
 
         public override IAstNode VisitInitializer( InitializerContext context )
         {
-            var value = ( IExpression )(context.Value?.Accept( this ) ?? new ConstantExpression( context.GetSourceLocation( ), 0.0 ));
-            return new LocalVariableDeclaration( context.GetSourceLocation()
+            var value = ( IExpression )(context.Value?.Accept( this ) ?? new ConstantExpression( context.GetSourceRange( ), 0.0 ));
+            return new LocalVariableDeclaration( context.GetSourceRange()
                                                , context.Name
                                                , value
                                                );
@@ -328,25 +328,25 @@ private IAstNode CreateBinaryOperatorNode( IExpression lhs, BinaryopContext op,
             switch(op.OpToken.Type)
             {
             case LEFTANGLE:
-                return new BinaryOperatorExpression( op.GetSourceLocation(), lhs, BuiltInOperatorKind.Less, rhs );
+                return new BinaryOperatorExpression( op.GetSourceRange(), lhs, BuiltInOperatorKind.Less, rhs );
 
             case CARET:
-                return new BinaryOperatorExpression( op.GetSourceLocation(), lhs, BuiltInOperatorKind.Pow, rhs );
+                return new BinaryOperatorExpression( op.GetSourceRange(), lhs, BuiltInOperatorKind.Pow, rhs );
 
             case PLUS:
-                return new BinaryOperatorExpression( op.GetSourceLocation(), lhs, BuiltInOperatorKind.Add, rhs );
+                return new BinaryOperatorExpression( op.GetSourceRange(), lhs, BuiltInOperatorKind.Add, rhs );
 
             case MINUS:
-                return new BinaryOperatorExpression( op.GetSourceLocation(), lhs, BuiltInOperatorKind.Subtract, rhs );
+                return new BinaryOperatorExpression( op.GetSourceRange(), lhs, BuiltInOperatorKind.Subtract, rhs );
 
             case ASTERISK:
-                return new BinaryOperatorExpression( op.GetSourceLocation(), lhs, BuiltInOperatorKind.Multiply, rhs );
+                return new BinaryOperatorExpression( op.GetSourceRange(), lhs, BuiltInOperatorKind.Multiply, rhs );
 
             case SLASH:
-                return new BinaryOperatorExpression( op.GetSourceLocation(), lhs, BuiltInOperatorKind.Divide, rhs );
+                return new BinaryOperatorExpression( op.GetSourceRange(), lhs, BuiltInOperatorKind.Divide, rhs );
 
             case ASSIGN:
-                return new BinaryOperatorExpression( op.GetSourceLocation(), lhs, BuiltInOperatorKind.Assign, rhs );
+                return new BinaryOperatorExpression( op.GetSourceRange(), lhs, BuiltInOperatorKind.Assign, rhs );
 
             #region UserBinaryOpExpression
             default:
@@ -355,14 +355,14 @@ private IAstNode CreateBinaryOperatorNode( IExpression lhs, BinaryopContext op,
                 var opKind = RuntimeState.GetBinOperatorInfo( op.OpToken.Type ).Kind;
                 if(opKind != OperatorKind.InfixLeftAssociative && opKind != OperatorKind.InfixRightAssociative)
                 {
-                    return new ErrorNode( op.GetSourceLocation(), $"Invalid binary operator '{op.OpToken.Text}'" );
+                    return new ErrorNode( op.GetSourceRange(), $"Invalid binary operator '{op.OpToken.Text}'" );
                 }
 
                 string calleeName = CreateBinaryFunctionName( op.OpToken );
                 Prototype? callTarget = FindCallTarget( calleeName );
                 return callTarget is null
-                    ? new ErrorNode( op.GetSourceLocation(), $"Unary operator function '{calleeName}' not found" )
-                    : new FunctionCallExpression( op.GetSourceLocation(), callTarget, lhs, rhs );
+                    ? new ErrorNode( op.GetSourceRange(), $"Unary operator function '{calleeName}' not found" )
+                    : new FunctionCallExpression( op.GetSourceRange(), callTarget, lhs, rhs );
             }
             #endregion
             }
@@ -385,7 +385,7 @@ private IAstNode BuildPrototype( PrototypeContext context, string name )
                 name = context.Name;
             }
 
-            var retVal = new Prototype( context.GetSourceLocation()
+            var retVal = new Prototype( context.GetSourceRange()
                                       , name
                                       , false
                                       , context.Parent is ExternalDeclarationContext
@@ -397,7 +397,7 @@ private IAstNode BuildPrototype( PrototypeContext context, string name )
             {
                 if(existingPrototype.Parameters.Count != retVal.Parameters.Count)
                 {
-                    return new ErrorNode( context.GetSourceLocation(), "Declaration incompatible with previous declaration" );
+                    return new ErrorNode( context.GetSourceRange(), "Declaration incompatible with previous declaration" );
                 }
             }
 

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/AST/BinaryOperatorExpression.cs

@@ -29,7 +29,7 @@ public sealed class BinaryOperatorExpression
         /// <param name="lhs">Left hand side expression for the operator</param>
         /// <param name="op">Operator type</param>
         /// <param name="rhs">Right hand side expression for the operator</param>
-        public BinaryOperatorExpression( SourceLocation location, IExpression lhs, BuiltInOperatorKind op, IExpression rhs )
+        public BinaryOperatorExpression( SourceRange location, IExpression lhs, BuiltInOperatorKind op, IExpression rhs )
             : base( location )
         {
             Left = lhs;

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/AST/ConditionalExpression.cs

@@ -11,7 +11,7 @@ public sealed class ConditionalExpression
         : AstNode
         , IExpression
     {
-        public ConditionalExpression( SourceLocation location
+        public ConditionalExpression( SourceRange location
                                     , IExpression condition
                                     , IExpression thenExpression
                                     , IExpression elseExpression

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/AST/ConstantExpression.cs

@@ -12,7 +12,7 @@ public sealed class ConstantExpression
         : AstNode
         , IExpression
     {
-        public ConstantExpression( SourceLocation location, double value )
+        public ConstantExpression( SourceRange location, double value )
             : base( location )
         {
             Value = value;

src/Samples/Kaleidoscope/Kaleidoscope.Grammar/AST/ForInExpression.cs

@@ -11,7 +11,7 @@ public sealed class ForInExpression
         : AstNode
         , IExpression
     {
-        public ForInExpression( SourceLocation location
+        public ForInExpression( SourceRange location
                               , LocalVariableDeclaration loopVariable
                               , IExpression condition
                               , IExpression step