Correctly use UTF-8 indices when highlighting diagnostic source #683
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Bug/issue #, if applicable: #678
Summary
Previously, the default diagnostic formatter would crash due to incorrect indices handling when trying to highlight a diagnostic source range.
A diagnostic's
SourceRange
is the range in the source file that emits the diagnostic. When highlighting a diagnostic source range, we use thecolumn
property of theupperBound
andlowerBound
to find indices of a source string that should be highlighted.The
column
property is The number of bytes in UTF-8 encoding.However, this was not taken into account previously when calculating the indices.
This pull request fixes this crash by using proper UTF-8 indices.
Testing
This functionally can be tested using the steps mentioned in #678.
docc preview --allow-arbitrary-catalog-directories swift/docs
Alternatively, the issue is easily reproducible by adding an emoji to a source line that would emit a diagnostic.
Checklist
Make sure you check off the following items. If they cannot be completed, provide a reason.
./bin/test
script and it succeeded