private void PopulatePropertiesFromStartAndEndProperties(NewLineIndex lineIndex, Region region, string fileText)
{
Assert(region.StartLine > 0);
// Note: execution order of these helpers is important, as some
// calls assume that certain preceding helpers have executed,
// with the result that certain properties are populated
// Populated at this point: StartLine
PopulateEndLine(region);
// Populated at this point: StartLine, EndLine
PopulateStartColumn(region);
// Populated at this point: StartLine, EndLine, StartColumn
PopulateEndColumn(lineIndex, region, fileText);
// Populated at this point: StartLine, EndLine, StartColumn, EndColumn
PopulateCharOffset(lineIndex, region);
// Populated at this point: StartLine, EndLine, StartColumn, EndColumn, CharOffset
PopulateCharLength(lineIndex, region);
// Populated at this point: StartLine, EndLine, StartColumn, EndColumn, CharOffset, CharLength
Assert(region.StartLine > 0);
Assert(region.EndLine > 0);
Assert((region.CharOffset + region.CharLength) <= fileText.Length);
Assert(region.StartColumn > 0);
Assert(region.CharLength > 0 || (region.StartColumn == region.EndColumn && region.StartLine == region.EndLine));
Assert(region.EndColumn > 0);
}
internal Region ConstructMultilineContextSnippet(Region inputRegion, Uri uri)
{
if (inputRegion == null || inputRegion.IsBinaryRegion)
{
// Context snippets are relevant only for textual regions.
return(null);
}
NewLineIndex newLineIndex = GetNewLineIndex(uri, out string fileText);
if (newLineIndex == null)
{
return(null);
}
int maxLineNumber = newLineIndex.MaximumLineNumber;
// Currently, we just grab a single line before and after the region start
// and end lines, respectively. In the future, we could make this configurable.
var region = new Region()
{
StartLine = inputRegion.StartLine == 1 ? 1 : inputRegion.StartLine - 1,
EndLine = inputRegion.EndLine == maxLineNumber ? maxLineNumber : inputRegion.EndLine + 1
};
return(this.PopulateTextRegionProperties(region, uri, populateSnippet: true));
}
private static void PopulateEndLine(NewLineIndex lineIndex, Region region)
{
// Populated at this point: StartLine
Debug.Assert(region.StartLine > 0);
region.EndLine = region.EndLine == 0 ? region.StartLine : region.EndLine;
}
private Region PopulateTextRegionProperties(NewLineIndex lineIndex, Region inputRegion, string fileText, bool populateSnippet)
{
// A GENERAL NOTE ON THE PROPERTY POPULATION PROCESS:
//
// As a rule, if we find some existing data on the region, we will trust it
// and avoid overwriting it. We will take every opportunity, however, to
// validate that the existing information matches what the new line index
// computes. Note that we could consider making the new line index more
// efficient by deferring its newline computations until they are
// actually requested. If we do so, we could update this code to
// avoid verifying region data in cases where regions are fully
// populated (and we can skip file parsing required to build
// the map of new line offsets).
Assert(!inputRegion.IsBinaryRegion);
// If we have no input source file, there is no work to do
if (lineIndex == null)
{
return(inputRegion);
}
Debug.Assert(fileText != null);
Region region = inputRegion.DeepClone();
if (region.StartLine == 0)
{
// This means we have a region specified entirely via charOffset
PopulatePropertiesFromCharOffsetAndLength(lineIndex, region);
}
else
{
PopulatePropertiesFromStartAndEndProperties(lineIndex, region, fileText);
}
if (populateSnippet &&
region.CharOffset >= 0 &&
region.CharLength >= 0 &&
(region.CharOffset + region.CharLength <= fileText.Length))
{
region.Snippet ??= new ArtifactContent();
string snippetText = fileText.Substring(region.CharOffset, region.CharLength);
if (region.Snippet.Text == null)
{
region.Snippet.Text = snippetText;
}
Assert(region.Snippet.Text == snippetText);
}
return(region);
}
/// <summary>
/// Accepts a physical location and returns a Region object, based on the input
/// physicalLocation.region property, that has all its properties populated. If an
/// input text region, for example, only specifies the startLine property, the returned
/// Region instance will have computed and populated other properties, such as charOffset,
/// charLength, etc.
/// </summary>
/// <param name="physicalLocation">The physical location containing the region which should be populated.</param>
/// <param name="populateSnippet">Specifies whether the physicalLocation.region.snippet property should be populated.</param>
/// <returns></returns>
public Region PopulateTextRegionProperties(Region inputRegion, Uri uri, bool populateSnippet)
{
if (inputRegion == null || inputRegion.IsBinaryRegion)
{
// For binary regions, only the byteOffset and byteLength properties
// are relevant, and their values are always specified.
return(inputRegion);
}
NewLineIndex newLineIndex = GetNewLineIndex(uri, out string fileText);
return(PopulateTextRegionProperties(newLineIndex, inputRegion, fileText, populateSnippet));
}
/// <summary>
/// Completely populate all Region property members. Missing data
/// is computed based on the values that are already present.
/// </summary>
/// <param name="region"></param>
/// <param name="newLineIndex"></param>
public static void Populate(this Region region, NewLineIndex newLineIndex)
{
if (region == null)
{
throw new ArgumentNullException(nameof(region));
}
if (newLineIndex == null)
{
throw new ArgumentNullException(nameof(newLineIndex));
}
// A call to Populate is an implicit indicator that we are working
// with a text region (otherwise the offset and length would be
// sufficient data to constitute the region).
if (region.StartLine == 0)
{
OffsetInfo offsetInfo = newLineIndex.GetOffsetInfoForOffset(region.Offset);
region.StartLine = offsetInfo.LineNumber;
region.StartColumn = offsetInfo.ColumnNumber;
offsetInfo = newLineIndex.GetOffsetInfoForOffset(region.Offset + region.Length);
region.EndLine = offsetInfo.LineNumber;
region.EndColumn = offsetInfo.ColumnNumber;
}
else
{
// Make endColumn and endLine explicit, if not expressed
if (region.EndLine == 0)
{
region.EndLine = region.StartLine;
}
if (region.StartColumn == 0)
{
region.StartColumn = 1;
}
if (region.EndColumn == 0)
{
region.EndColumn = region.StartColumn;
}
LineInfo lineInfo = newLineIndex.GetLineInfoForLine(region.StartLine);
region.Offset = lineInfo.StartOffset + (region.StartColumn - 1);
lineInfo = newLineIndex.GetLineInfoForLine(region.EndLine);
region.Length = lineInfo.StartOffset + (region.EndColumn - 1) - region.Offset;
}
}
private void PopulatePropertiesFromCharOffsetAndLength(NewLineIndex newLineIndex, Region region)
{
Assert(!region.IsBinaryRegion);
Assert(region.StartLine == 0);
Assert(region.CharLength >= 0 || region.CharOffset >= 0);
int startLine, startColumn, endLine, endColumn;
// Retrieve start and end line and column information from the new line index
OffsetInfo offsetInfo = newLineIndex.GetOffsetInfoForOffset(region.CharOffset);
startLine = offsetInfo.LineNumber;
startColumn = offsetInfo.ColumnNumber;
offsetInfo = newLineIndex.GetOffsetInfoForOffset(region.CharOffset + region.CharLength);
endLine = offsetInfo.LineNumber;
// The computation above points one past our actual region, because endColumn
// is exclusive of the region. This allows for length to easily be computed
// for single line regions: region.EndColumn - region.StartColumn
endColumn = offsetInfo.ColumnNumber;
// Only set values if they aren't already specified
if (region.StartLine == 0)
{
region.StartLine = startLine;
}
if (region.StartColumn == 0)
{
region.StartColumn = startColumn;
}
if (region.EndLine == 0)
{
region.EndLine = endLine;
}
if (region.EndColumn == 0)
{
region.EndColumn = endColumn;
}
// Validate cases where new line index disagrees with explicit values
Assert(region.StartLine == startLine);
Assert(region.StartColumn == startColumn);
Assert(region.EndLine == endLine);
Assert(region.EndColumn == endColumn);
}
private NewLineIndex GetNewLineIndex(Uri uri, string fileText = null)
{
NewLineIndex newLineIndex = null;
if (!_cache.ContainsKey(uri.LocalPath) && fileText != null)
{
newLineIndex = new NewLineIndex(fileText);
_cache[uri.LocalPath] =
new Tuple <string, NewLineIndex>(item1: uri.LocalPath, item2: newLineIndex);
}
else
{
Tuple <string, NewLineIndex> entry = _cache[uri.LocalPath];
newLineIndex = entry.Item2;
}
return(newLineIndex);
}
/// <summary>
/// Method to build cache entries which aren't already in the cache.
/// </summary>
/// <param name="localPath">Uri.LocalPath for the file to load</param>
/// <returns>Cache entry to add to cache with file contents and NewLineIndex</returns>
private Tuple <string, NewLineIndex> BuildIndexForFile(string localPath)
{
string fileText = null;
NewLineIndex index = null;
// We will expand this code later to construct all possible URLs from
// the log file, bearing in mind things like uriBaseIds. Also, we could
// consider downloading and caching web-hosted source files.
try
{
fileText = _fileSystem.ReadAllText(localPath);
}
catch (IOException) { }
if (fileText != null)
{
index = new NewLineIndex(fileText);
}
return(new Tuple <string, NewLineIndex>(fileText, index));
}
private void PopulateCharLength(NewLineIndex lineIndex, Region region)
{
// Populated at this point: StartLine, EndLine, StartColumn, EndColumn, CharOffset
Assert(region.StartLine > 0);
Assert(region.EndLine > 0);
Assert(region.StartColumn > 0);
Assert(region.EndColumn > 0);
Assert(region.CharOffset > 0 || (region.StartLine == 1 && region.StartColumn == 1));
LineInfo lineInfo = lineIndex.GetLineInfoForLine(region.EndLine);
int charLength = lineInfo.StartOffset;
charLength -= region.CharOffset;
charLength += region.EndColumn - 1;
if (region.CharLength == 0)
{
region.CharLength = charLength;
}
Assert(region.CharLength == charLength);
}
private static void PopulateCharOffset(NewLineIndex lineIndex, Region region, string fileText)
{
// Populated at this point: StartLine, EndLine, StartColumn, EndColumn
Debug.Assert(region.StartLine > 0);
Debug.Assert(region.EndLine > 0);
Debug.Assert(region.StartColumn > 0);
Debug.Assert(region.EndColumn > 0);
LineInfo lineInfo = lineIndex.GetLineInfoForLine(region.StartLine);
// Now we have the offset of the starting line. Populate region.CharOffset.
int offset = lineInfo.StartOffset;
offset += region.StartColumn - 1;
if (region.CharOffset == 0)
{
region.CharOffset = offset;
}
Debug.Assert(region.CharOffset == offset);
}
private NewLineIndex GetNewLineIndex(Uri uri, string fileText = null)
{
string path = uri.GetFilePath();
NewLineIndex newLineIndex;
if (!_cache.ContainsKey(path) && fileText != null)
{
newLineIndex = new NewLineIndex(fileText);
_cache[path] =
new Tuple <string, NewLineIndex>(item1: path, item2: newLineIndex);
}
else
{
Tuple <string, NewLineIndex> entry = _cache[path];
newLineIndex = entry.Item2;
}
return(newLineIndex);
}
private void PopulateEndColumn(NewLineIndex lineIndex, Region region, string fileText)
{
// Populated at this point: StartLine, EndLine, StartColumn
Assert(region.StartLine > 0);
Assert(region.StartColumn > 0);
Assert(region.EndLine > 0);
if (region.EndColumn == 0)
{
// No explicit end column. Increment from end line through
// the end of the line, excluding new line characters
LineInfo lineInfo = lineIndex.GetLineInfoForLine(region.EndLine);
int endColumnOffset = lineInfo.StartOffset;
while (endColumnOffset < fileText.Length &&
!NewLineIndex.s_newLineCharSet.Contains(fileText[endColumnOffset]))
{
endColumnOffset++;
}
// End columns are 1-indexed
region.EndColumn = endColumnOffset - lineInfo.StartOffset + 1;
}
}
/// <summary>
/// Completely populate all Region property members. Missing data
/// is computed based on the values that are already present.
/// </summary>
/// <param name="region"></param>
/// <param name="newLineIndex"></param>
public static void Populate(this Region region, NewLineIndex newLineIndex)
{
if (region == null)
{
throw new ArgumentNullException(nameof(region));
}
if (newLineIndex == null)
{
throw new ArgumentNullException(nameof(newLineIndex));
}
// A call to Populate is an implicit indicator that we are working
// with a text region (otherwise the offset and length would be
// sufficient data to constitute the region).
if (region.StartLine == 0)
{
OffsetInfo offsetInfo = newLineIndex.GetOffsetInfoForOffset(region.Offset);
region.StartLine = offsetInfo.LineNumber;
region.StartColumn = offsetInfo.ColumnNumber;
offsetInfo = newLineIndex.GetOffsetInfoForOffset(region.Offset + region.Length);
region.EndLine = offsetInfo.LineNumber;
region.EndColumn = offsetInfo.ColumnNumber;
}
else
{
// Make endColumn and endLine explicit, if not expressed
if (region.EndLine == 0) { region.EndLine = region.StartLine; }
if (region.StartColumn == 0) { region.StartColumn = 1; }
if (region.EndColumn == 0) { region.EndColumn = region.StartColumn; }
LineInfo lineInfo = newLineIndex.GetLineInfoForLine(region.StartLine);
region.Offset = lineInfo.StartOffset + (region.StartColumn - 1);
lineInfo = newLineIndex.GetLineInfoForLine(region.EndLine);
region.Length = lineInfo.StartOffset + (region.EndColumn - 1) - region.Offset;
}
}