Refine VariableVisitor to use ScriptExtentAdapter

Author: JustinGrote

src/PowerShellEditorServices/Services/PowerShell/Handlers/RenameHandler.cs

@@ -41,7 +41,7 @@ public async Task<RangeOrPlaceholderRange> Handle(PrepareRenameParams request, C
         if (token is null) { return null; }
 
         // TODO: Really should have a class with implicit convertors handing these conversions to avoid off-by-one mistakes.
-        return Utilities.ToRange(token.Extent); ;
+        return new ScriptExtentAdapter(token.Extent);
     }
 
     /// <summary>
@@ -211,7 +211,6 @@ public ScriptPositionAdapter(Position position) : this(position.Line + 1, positi
     public static implicit operator ScriptPositionAdapter(ScriptPosition position) => new(position);
 
     public static implicit operator Position(ScriptPositionAdapter scriptPosition) => new(scriptPosition.position.LineNumber - 1, scriptPosition.position.ColumnNumber - 1);
-
     public static implicit operator ScriptPosition(ScriptPositionAdapter position) => position;
 
     internal ScriptPositionAdapter Delta(int LineAdjust, int ColumnAdjust) => new(
@@ -242,26 +241,20 @@ internal record ScriptExtentAdapter(IScriptExtent extent) : IScriptExtent
     public ScriptPositionAdapter End = new(extent.EndScriptPosition);
 
     public static implicit operator ScriptExtentAdapter(ScriptExtent extent) => new(extent);
-    public static implicit operator ScriptExtent(ScriptExtentAdapter extent) => extent;
-
-    public static implicit operator Range(ScriptExtentAdapter extent) => new()
-    {
-        Start = extent.Start,
-        End = extent.End
-        // End = extent.End with
-        // {
-        //     // The end position in Script Extents is actually shifted an additional 1 column, no idea why
-        //     // https://learn.microsoft.com/en-us/dotnet/api/system.management.automation.language.iscriptextent.endscriptposition?view=powershellsdk-7.4.0#system-management-automation-language-iscriptextent-endscriptposition
-
-        //     position = (extent.EndScriptPosition as ScriptPositionAdapter).Delta(0, -1)
-        // }
-    };
     public static implicit operator ScriptExtentAdapter(Range range) => new(new ScriptExtent(
         // Will get shifted to 1-based
         new ScriptPositionAdapter(range.Start),
         new ScriptPositionAdapter(range.End)
     ));
 
+    public static implicit operator ScriptExtent(ScriptExtentAdapter adapter) => adapter;
+    public static implicit operator Range(ScriptExtentAdapter adapter) => new()
+    {
+        Start = adapter.Start,
+        End = adapter.End
+    };
+    public static implicit operator RangeOrPlaceholderRange(ScriptExtentAdapter adapter) => new(adapter);
+
     public IScriptPosition StartScriptPosition => Start;
     public IScriptPosition EndScriptPosition => End;
     public int EndColumnNumber => End.ColumnNumber;

src/PowerShellEditorServices/Services/PowerShell/Refactoring/IterativeVariableVisitor.cs

@@ -400,7 +400,7 @@ private void ProcessVariableExpressionAst(VariableExpressionAst variableExpressi
                     TextEdit Change = new()
                     {
                         NewText = NewName.Contains("$") ? NewName : "$" + NewName,
-                        Range = Utilities.ToRange(variableExpressionAst.Extent),
+                        Range = new ScriptExtentAdapter(variableExpressionAst.Extent),
                     };
                     // If the variables parent is a parameterAst Add a modification
                     if (variableExpressionAst.Parent is ParameterAst paramAst && !AliasSet &&
@@ -432,7 +432,7 @@ private void ProcessCommandParameterAst(CommandParameterAst commandParameterAst)
                     TextEdit Change = new()
                     {
                         NewText = NewName.Contains("-") ? NewName : "-" + NewName,
-                        Range = Utilities.ToRange(commandParameterAst.Extent)
+                        Range = new ScriptExtentAdapter(commandParameterAst.Extent)
                     };
                     Modifications.Add(Change);
                 }
@@ -466,7 +466,7 @@ assignmentStatementAst.Right is CommandExpressionAst commExpAst &&
                         TextEdit Change = new()
                         {
                             NewText = NewName,
-                            Range = Utilities.ToRange(strConstAst.Extent)
+                            Range = new ScriptExtentAdapter(strConstAst.Extent)
                         };
 
                         Modifications.Add(Change);
@@ -500,7 +500,7 @@ internal TextEdit NewParameterAliasChange(VariableExpressionAst variableExpressi
                         aliasChange = aliasChange with
                         {
                             NewText = $"[Alias({nentries})]",
-                            Range = Utilities.ToRange(AttrAst.Extent)
+                            Range = new ScriptExtentAdapter(AttrAst.Extent)
                         };
                     }
                 }
@@ -510,7 +510,7 @@ internal TextEdit NewParameterAliasChange(VariableExpressionAst variableExpressi
                 aliasChange = aliasChange with
                 {
                     NewText = $"[Alias(\"{OldName}\")]",
-                    Range = Utilities.ToRange(paramAst.Extent)
+                    Range = new ScriptExtentAdapter(paramAst.Extent)
                 };
             }
 

src/PowerShellEditorServices/Services/PowerShell/Refactoring/Utilities.cs

@@ -5,34 +5,11 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Management.Automation.Language;
-using OmniSharp.Extensions.LanguageServer.Protocol.Models;
 
 namespace Microsoft.PowerShell.EditorServices.Refactoring
 {
     internal class Utilities
     {
-        /// <summary>
-        /// Helper function to convert 1-based script positions to zero-based LSP positions
-        /// </summary>
-        /// <param name="extent"></param>
-        /// <returns></returns>
-        public static Range ToRange(IScriptExtent extent)
-        {
-            return new Range
-            {
-                Start = new Position
-                {
-                    Line = extent.StartLineNumber - 1,
-                    Character = extent.StartColumnNumber - 1
-                },
-                End = new Position
-                {
-                    Line = extent.EndLineNumber - 1,
-                    Character = extent.EndColumnNumber - 1
-                }
-            };
-        }
-
         public static Ast GetAstAtPositionOfType(int StartLineNumber, int StartColumnNumber, Ast ScriptAst, params Type[] type)
         {
             Ast result = null;