Skip to content

Stop replacing variables in path tab completion #21148

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
MartinGC94 wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Stop replacing variables in path tab completion #21148

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
963e6b9
Stop replacing vars in path tab completion
MartinGC94 Jan 28, 2024
79c0f6b
Add missing tests and comment
MartinGC94 Jan 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
65 changes: 32 additions & 33 deletions src/System.Management.Automation/engine/CommandCompletion/CompletionAnalysis.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1787,7 +1787,11 @@ private static List<CompletionResult> GetResultForString(CompletionContext compl

var commandElementAst = lastAst as CommandElementAst;
string wordToComplete =
CompletionCompleters.ConcatenateStringPathArguments(commandElementAst, string.Empty, completionContext);
CompletionCompleters.ConcatenateStringPathArguments(
commandElementAst,
string.Empty,
completionContext,
out List<CompletionCompleters.ExpressionValue> nestedExpressions);

if (wordToComplete != null)
{
Expand All @@ -1796,15 +1800,15 @@ private static List<CompletionResult> GetResultForString(CompletionContext compl
// Handle scenarios like this: cd 'c:\windows\win'<tab>
if (lastAst.Parent is CommandAst || lastAst.Parent is CommandParameterAst)
{
result = CompletionCompleters.CompleteCommandArgument(completionContext);
result = CompletionCompleters.CompleteCommandArgument(completionContext, nestedExpressions);
replacementIndex = completionContext.ReplacementIndex;
replacementLength = completionContext.ReplacementLength;
}
// Handle scenarios like this: "c:\wind"<tab>. Treat the StringLiteral/StringExpandable as path/command
else
{
// Handle path/commandname completion for quoted string
result = new List<CompletionResult>(CompletionCompleters.CompleteFilename(completionContext));
result = new List<CompletionResult>(CompletionCompleters.CompleteFilename(completionContext, nestedExpressions));

// Try command name completion only if the text contains '-'
if (wordToComplete.Contains('-'))
Expand Down Expand Up @@ -1976,7 +1980,7 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c
StringLiterals.PowerShellILExecutableExtension,
StringLiterals.PowerShellCmdletizationFileExtension
};
result = CompletionCompleters.CompleteFilename(completionContext, false, moduleExtensions).ToList();
result = CompletionCompleters.CompleteFilename(completionContext, extension: moduleExtensions).ToList();
if (completionContext.WordToComplete.IndexOfAny(Utils.Separators.DirectoryOrDrive) != -1)
{
// The partial input is a path, then we don't iterate modules under $ENV:PSModulePath
Expand Down Expand Up @@ -2007,6 +2011,7 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c
}
}

List<CompletionCompleters.ExpressionValue> nestedExpressions = null;
if ((tokenAtCursor.TokenFlags & TokenFlags.CommandName) != 0)
{
// Handle completion for a path with variable, such as: $PSHOME\ty<tab>
Expand All @@ -2024,11 +2029,15 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c
if (tokenAtCursorText.AsSpan().IndexOfAny('\\', '/') == 0)
{
string wordToComplete =
CompletionCompleters.ConcatenateStringPathArguments(cursorAst as CommandElementAst, tokenAtCursorText, completionContext);
CompletionCompleters.ConcatenateStringPathArguments(
cursorAst as CommandElementAst,
tokenAtCursorText,
completionContext,
out nestedExpressions);
if (wordToComplete != null)
{
completionContext.WordToComplete = wordToComplete;
result = new List<CompletionResult>(CompletionCompleters.CompleteFilename(completionContext));
result = new List<CompletionResult>(CompletionCompleters.CompleteFilename(completionContext, nestedExpressions));
if (result.Count > 0)
{
replacementIndex = cursorAst.Extent.StartScriptPosition.Offset;
Expand All @@ -2044,7 +2053,8 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c
? CompletionCompleters.CombineVariableWithPartialPath(
variableAst: variableAst,
extraText: tokenAtCursorText,
executionContext: completionContext.ExecutionContext)
executionContext: completionContext.ExecutionContext,
out nestedExpressions)
: null;

if (fullPath == null) { return result; }
Expand Down Expand Up @@ -2086,10 +2096,10 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c
{
string expandedString = null;
var expandableStringAst = new ExpandableStringExpressionAst(strConst.Extent, strConst.Value, StringConstantType.BareWord);
if (CompletionCompleters.IsPathSafelyExpandable(expandableStringAst: expandableStringAst,
if (CompletionCompleters.IsPathSafelyExpandable(expandableString: expandableStringAst,
extraText: string.Empty,
executionContext: completionContext.ExecutionContext,
expandedString: out expandedString))
expandedString: out expandedString, out nestedExpressions))
{
completionContext.WordToComplete = expandedString;
}
Expand Down Expand Up @@ -2118,7 +2128,7 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c
}

// Handle the file completion before command name completion
result = CompleteFileNameAsCommand(completionContext);
result = CompleteFileNameAsCommand(completionContext, nestedExpressions);
// Handle the command name completion
var commandNameResult = CompletionCompleters.CompleteCommand(completionContext);

Expand Down Expand Up @@ -2256,7 +2266,7 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c
if (lastAst.Parent is FileRedirectionAst || CompleteAgainstSwitchFile(lastAst, completionContext.TokenBeforeCursor))
{
string wordToComplete =
CompletionCompleters.ConcatenateStringPathArguments(lastAst as CommandElementAst, string.Empty, completionContext);
CompletionCompleters.ConcatenateStringPathArguments(lastAst as CommandElementAst, string.Empty, completionContext, out nestedExpressions);
if (wordToComplete != null)
{
needFileCompletion = true;
Expand All @@ -2274,7 +2284,7 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c
fileRedirection.Extent.EndColumnNumber == lastAst.Extent.StartColumnNumber)
{
string wordToComplete =
CompletionCompleters.ConcatenateStringPathArguments(fileRedirection.Location, tokenAtCursorText, completionContext);
CompletionCompleters.ConcatenateStringPathArguments(fileRedirection.Location, tokenAtCursorText, completionContext, out nestedExpressions);

if (wordToComplete != null)
{
Expand All @@ -2292,19 +2302,23 @@ private static List<CompletionResult> GetResultForIdentifier(CompletionContext c

if (needFileCompletion)
{
return new List<CompletionResult>(CompletionCompleters.CompleteFilename(completionContext));
return new List<CompletionResult>(CompletionCompleters.CompleteFilename(completionContext, nestedExpressions));
}
else
{
string wordToComplete =
CompletionCompleters.ConcatenateStringPathArguments(lastAst as CommandElementAst, string.Empty, completionContext);
CompletionCompleters.ConcatenateStringPathArguments(
lastAst as CommandElementAst,
string.Empty,
completionContext,
out nestedExpressions);
if (wordToComplete != null)
{
completionContext.WordToComplete = wordToComplete;
}
}

result = CompletionCompleters.CompleteCommandArgument(completionContext);
result = CompletionCompleters.CompleteCommandArgument(completionContext, nestedExpressions);
replacementIndex = completionContext.ReplacementIndex;
replacementLength = completionContext.ReplacementLength;

Expand Down Expand Up @@ -2375,10 +2389,10 @@ private static List<CompletionResult> GetResultForAttributeArgument(CompletionCo
/// Complete file name as command.
/// </summary>
/// <param name="completionContext"></param>
/// <param name="nestedExpressions"></param>
/// <returns></returns>
private static List<CompletionResult> CompleteFileNameAsCommand(CompletionContext completionContext)
private static List<CompletionResult> CompleteFileNameAsCommand(CompletionContext completionContext, List<CompletionCompleters.ExpressionValue> nestedExpressions = null)
{
var addAmpersandIfNecessary = CompletionCompleters.IsAmpersandNeeded(completionContext, true);
var result = new List<CompletionResult>();
var clearLiteralPathsKey = false;

Expand All @@ -2395,22 +2409,7 @@ private static List<CompletionResult> CompleteFileNameAsCommand(CompletionContex

try
{
var fileNameResult = CompletionCompleters.CompleteFilename(completionContext);
foreach (var entry in fileNameResult)
{
// Add '&' to file names that are quoted
var completionText = entry.CompletionText;
var len = completionText.Length;
if (addAmpersandIfNecessary && len > 2 && completionText[0].IsSingleQuote() && completionText[len - 1].IsSingleQuote())
{
completionText = "& " + completionText;
result.Add(new CompletionResult(completionText, entry.ListItemText, entry.ResultType, entry.ToolTip));
}
else
{
result.Add(entry);
}
}
result.AddRange(CompletionCompleters.CompleteFilename(completionContext, nestedExpressions, asCommand: true));
}
finally
{
Expand Down
Loading