/// <summary>
/// Finds all the occurences of a symbol in the script given a file location
/// </summary>
/// <param name="file">The details and contents of a open script file</param>
/// <param name="lineNumber">The line number of the cursor for the given script</param>
/// <param name="columnNumber">The coulumn number of the cursor for the given script</param>
/// <returns>FindOccurrencesResult</returns>
public FindOccurrencesResult FindOccurrencesInFile(
ScriptFile file,
int lineNumber,
int columnNumber)
{
SymbolReference foundSymbol =
AstOperations.FindSymbolAtPosition(
file.ScriptAst,
lineNumber,
columnNumber);
if (foundSymbol != null)
{
// find all references, and indicate that looking for aliases is not needed
IEnumerable <SymbolReference> symbolOccurrences =
AstOperations
.FindReferencesOfSymbol(
file.ScriptAst,
foundSymbol,
false);
return
(new FindOccurrencesResult
{
FoundOccurrences = symbolOccurrences
});
}
else
{
return(null);
}
}
/// <summary>
/// Finds the details of the symbol at the given script file location.
/// </summary>
/// <param name="scriptFile">The ScriptFile in which the symbol can be located.</param>
/// <param name="lineNumber">The line number at which the symbol can be located.</param>
/// <param name="columnNumber">The column number at which the symbol can be located.</param>
/// <returns></returns>
public async Task <SymbolDetails> FindSymbolDetailsAtLocation(
ScriptFile scriptFile,
int lineNumber,
int columnNumber)
{
SymbolDetails symbolDetails = null;
SymbolReference symbolReference =
AstOperations.FindSymbolAtPosition(
scriptFile.ScriptAst,
lineNumber,
columnNumber);
if (symbolReference != null)
{
symbolReference.FilePath = scriptFile.FilePath;
symbolDetails =
await SymbolDetails.Create(
symbolReference,
this.powerShellContext);
}
else
{
// TODO #21: Return Result<T>
return(null);
}
return(symbolDetails);
}
/// <summary>
/// Finds the details of the symbol at the given script file location.
/// </summary>
/// <param name="scriptFile">The ScriptFile in which the symbol can be located.</param>
/// <param name="lineNumber">The line number at which the symbol can be located.</param>
/// <param name="columnNumber">The column number at which the symbol can be located.</param>
/// <returns></returns>
public async Task <SymbolDetails> FindSymbolDetailsAtLocation(
ScriptFile scriptFile,
int lineNumber,
int columnNumber)
{
SymbolDetails symbolDetails = null;
SymbolReference symbolReference =
AstOperations.FindSymbolAtPosition(
scriptFile.ScriptAst,
lineNumber,
columnNumber);
if (symbolReference != null)
{
RunspaceHandle runspaceHandle =
await this.powerShellContext.GetRunspaceHandle();
symbolReference.FilePath = scriptFile.FilePath;
symbolDetails = new SymbolDetails(symbolReference, runspaceHandle.Runspace);
runspaceHandle.Dispose();
}
else
{
// TODO #21: Return Result<T>
return(null);
}
return(symbolDetails);
}
/// <summary>
/// Finds the details of the symbol at the given script file location.
/// </summary>
/// <param name="scriptFile">The ScriptFile in which the symbol can be located.</param>
/// <param name="lineNumber">The line number at which the symbol can be located.</param>
/// <param name="columnNumber">The column number at which the symbol can be located.</param>
/// <returns></returns>
public async Task <SymbolDetails> FindSymbolDetailsAtLocation(
ScriptFile scriptFile,
int lineNumber,
int columnNumber)
{
SymbolDetails symbolDetails = null;
SymbolReference symbolReference =
AstOperations.FindSymbolAtPosition(
scriptFile.ScriptAst,
lineNumber,
columnNumber);
if (symbolReference != null)
{
// Request a runspace handle with a short timeout
RunspaceHandle runspaceHandle =
await this.powerShellContext.GetRunspaceHandle(
new CancellationTokenSource(DefaultWaitTimeoutMilliseconds).Token);
symbolReference.FilePath = scriptFile.FilePath;
symbolDetails = new SymbolDetails(symbolReference, runspaceHandle.Runspace);
runspaceHandle.Dispose();
}
else
{
// TODO #21: Return Result<T>
return(null);
}
return(symbolDetails);
}
/// <summary>
/// Finds the symbol in the script given a file location
/// </summary>
/// <param name="scriptFile">The details and contents of a open script file</param>
/// <param name="lineNumber">The line number of the cursor for the given script</param>
/// <param name="columnNumber">The coulumn number of the cursor for the given script</param>
/// <returns>A SymbolReference of the symbol found at the given location
/// or null if there is no symbol at that location
/// </returns>
public SymbolReference FindSymbolAtLocation(
ScriptFile scriptFile,
int lineNumber,
int columnNumber)
{
SymbolReference symbolReference =
AstOperations.FindSymbolAtPosition(
scriptFile.ScriptAst,
lineNumber,
columnNumber);
if (symbolReference != null)
{
symbolReference.FilePath = scriptFile.FilePath;
}
return(symbolReference);
}