/// <summary>
/// Gets completions for a statement contained in the given
/// script file at the specified line and column position.
/// </summary>
/// <param name="scriptFile">
/// The script file in which completions will be gathered.
/// </param>
/// <param name="lineNumber">
/// The 1-based line number at which completions will be gathered.
/// </param>
/// <param name="columnNumber">
/// The 1-based column number at which completions will be gathered.
/// </param>
/// <returns>
/// A CommandCompletion instance completions for the identified statement.
/// </returns>
internal async Task <IEnumerable <CompletionItem> > GetCompletionsInFileAsync(
ScriptFile scriptFile,
int lineNumber,
int columnNumber,
CancellationToken cancellationToken)
{
Validate.IsNotNull(nameof(scriptFile), scriptFile);
CommandCompletion result = await AstOperations.GetCompletionsAsync(
scriptFile.ScriptAst,
scriptFile.ScriptTokens,
scriptFile.GetOffsetAtPosition(lineNumber, columnNumber),
_executionService,
_logger,
cancellationToken).ConfigureAwait(false);
if (result.CompletionMatches.Count == 0)
{
return(Array.Empty <CompletionItem>());
}
BufferRange replacedRange = scriptFile.GetRangeBetweenOffsets(
result.ReplacementIndex,
result.ReplacementIndex + result.ReplacementLength);
// Create OmniSharp CompletionItems from PowerShell CompletionResults. We use a for loop
// because the index is used for sorting.
CompletionItem[] completionItems = new CompletionItem[result.CompletionMatches.Count];
for (int i = 0; i < result.CompletionMatches.Count; i++)
{
completionItems[i] = CreateCompletionItem(result.CompletionMatches[i], replacedRange, i + 1);
}
return(completionItems);
}
/// <summary>
/// Gets completions for a statement contained in the given
/// script file at the specified line and column position.
/// </summary>
/// <param name="scriptFile">
/// The script file in which completions will be gathered.
/// </param>
/// <param name="lineNumber">
/// The 1-based line number at which completions will be gathered.
/// </param>
/// <param name="columnNumber">
/// The 1-based column number at which completions will be gathered.
/// </param>
/// <returns>
/// A CommandCompletion instance completions for the identified statement.
/// </returns>
public async Task <CompletionResults> GetCompletionsInFileAsync(
ScriptFile scriptFile,
int lineNumber,
int columnNumber)
{
Validate.IsNotNull(nameof(scriptFile), scriptFile);
// Get the offset at the specified position. This method
// will also validate the given position.
int fileOffset =
scriptFile.GetOffsetAtPosition(
lineNumber,
columnNumber);
CommandCompletion commandCompletion = null;
using (var cts = new CancellationTokenSource(DefaultWaitTimeoutMilliseconds))
{
commandCompletion =
await AstOperations.GetCompletionsAsync(
scriptFile.ScriptAst,
scriptFile.ScriptTokens,
fileOffset,
_powerShellContextService,
_logger,
cts.Token).ConfigureAwait(false);
}
if (commandCompletion == null)
{
return(new CompletionResults());
}
try
{
CompletionResults completionResults =
CompletionResults.Create(
scriptFile,
commandCompletion);
// save state of most recent completion
_mostRecentCompletions = completionResults;
_mostRecentRequestFile = scriptFile.Id;
_mostRecentRequestLine = lineNumber;
_mostRecentRequestOffest = columnNumber;
return(completionResults);
}
catch (ArgumentException e)
{
// Bad completion results could return an invalid
// replacement range, catch that here
_logger.LogError(
$"Caught exception while trying to create CompletionResults:\n\n{e.ToString()}");
return(new CompletionResults());
}
}