Properly handle and test a11y movement at end of buffer #7792
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -1136,58 +1136,110 @@ class UiaTextRangeTests | |
| // the UTR should refuse to move past the end. | ||
|
|
||
| const auto bufferSize{ _pTextBuffer->GetSize() }; | ||
| const COORD origin{ bufferSize.Origin() }; | ||
| const COORD lastLineStart{ bufferSize.Left(), bufferSize.BottomInclusive() }; | ||
| const COORD secondToLastCharacterPos{ bufferSize.RightInclusive() - 1, bufferSize.BottomInclusive() }; | ||
| const COORD endInclusive{ bufferSize.RightInclusive(), bufferSize.BottomInclusive() }; | ||
| const COORD endExclusive{ bufferSize.EndExclusive() }; | ||
|
|
||
| // Iterate over each TextUnit. If we don't support | ||
| // the given TextUnit, we're supposed to fallback | ||
| // to the last one that was defined anyways. | ||
| BEGIN_TEST_METHOD_PROPERTIES() | ||
| TEST_METHOD_PROPERTY(L"Data:textUnit", L"{0, 1, 2, 3, 4, 5, 6}") | ||
| TEST_METHOD_PROPERTY(L"Data:degenerate", L"{false, true}") | ||
| END_TEST_METHOD_PROPERTIES(); | ||
carlos-zamora marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| int unit; | ||
| bool degenerate; | ||
| VERIFY_SUCCEEDED(TestData::TryGetValue(L"textUnit", unit), L"Get TextUnit variant"); | ||
| VERIFY_SUCCEEDED(TestData::TryGetValue(L"degenerate", degenerate), L"Get degenerate variant"); | ||
| TextUnit textUnit{ static_cast<TextUnit>(unit) }; | ||
|
|
||
| Microsoft::WRL::ComPtr<UiaTextRange> utr; | ||
| int moveAmt; | ||
| Log::Comment(NoThrowString().Format(L"Forward by %s", toString(textUnit))); | ||
|
|
||
| // Create an UTR at EndExclusive | ||
| if (degenerate) | ||
| { | ||
| THROW_IF_FAILED(Microsoft::WRL::MakeAndInitialize<UiaTextRange>(&utr, _pUiaData, &_dummyProvider, endExclusive, endExclusive)); | ||
| } | ||
| else | ||
| { | ||
| THROW_IF_FAILED(Microsoft::WRL::MakeAndInitialize<UiaTextRange>(&utr, _pUiaData, &_dummyProvider, endInclusive, endExclusive)); | ||
| } | ||
| THROW_IF_FAILED(utr->Move(textUnit, 1, &moveAmt)); | ||
|
|
||
| VERIFY_ARE_EQUAL(endExclusive, utr->_end); | ||
carlos-zamora marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| VERIFY_ARE_EQUAL(0, moveAmt); | ||
|
|
||
| // write "temp" at (2,2) | ||
| const COORD writeTarget{ 2, 2 }; | ||
| _pTextBuffer->Write({ L"temp" }, writeTarget); | ||
|
|
||
| // Verify expansion works properly | ||
| Log::Comment(NoThrowString().Format(L"Expand by %s", toString(textUnit))); | ||
| THROW_IF_FAILED(utr->ExpandToEnclosingUnit(textUnit)); | ||
| if (textUnit <= TextUnit::TextUnit_Character) | ||
| { | ||
| VERIFY_ARE_EQUAL(endInclusive, utr->_start); | ||
| VERIFY_ARE_EQUAL(endExclusive, utr->_end); | ||
| } | ||
| else if (textUnit <= TextUnit::TextUnit_Word) | ||
| { | ||
| VERIFY_ARE_EQUAL(writeTarget, utr->_start); | ||
| VERIFY_ARE_EQUAL(endExclusive, utr->_end); | ||
| } | ||
| else if (textUnit <= TextUnit::TextUnit_Line) | ||
| { | ||
| VERIFY_ARE_EQUAL(lastLineStart, utr->_start); | ||
| VERIFY_ARE_EQUAL(endExclusive, utr->_end); | ||
| } | ||
| else // textUnit <= TextUnit::TextUnit_Document: | ||
| { | ||
| VERIFY_ARE_EQUAL(origin, utr->_start); | ||
| VERIFY_ARE_EQUAL(endExclusive, utr->_end); | ||
| } | ||
|
|
||
| // reset the UTR | ||
| if (degenerate) | ||
| { | ||
| THROW_IF_FAILED(Microsoft::WRL::MakeAndInitialize<UiaTextRange>(&utr, _pUiaData, &_dummyProvider, endExclusive, endExclusive)); | ||
| } | ||
| else | ||
| { | ||
| THROW_IF_FAILED(Microsoft::WRL::MakeAndInitialize<UiaTextRange>(&utr, _pUiaData, &_dummyProvider, endInclusive, endExclusive)); | ||
| } | ||
|
|
||
| // Verify that moving backwards still works properly | ||
| Log::Comment(NoThrowString().Format(L"Backwards by %s", toString(textUnit))); | ||
| THROW_IF_FAILED(utr->Move(textUnit, -1, &moveAmt)); | ||
carlos-zamora marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| VERIFY_ARE_EQUAL(-1, moveAmt); | ||
|
|
||
| // NOTE: If the range is degenerate, _start == _end before AND after the move. | ||
| if (textUnit <= TextUnit::TextUnit_Character) | ||
| { | ||
| // Special case: _end will always be endInclusive, because... | ||
| // - degenerate --> it moves with _start to stay degenerate | ||
| // - !degenerate --> it excludes the last char, to select the second to last char | ||
| VERIFY_ARE_EQUAL(degenerate ? endInclusive : secondToLastCharacterPos, utr->_start); | ||
| VERIFY_ARE_EQUAL(endInclusive, utr->_end); | ||
| } | ||
| else if (textUnit <= TextUnit::TextUnit_Word) | ||
| { | ||
| VERIFY_ARE_EQUAL(origin, utr->_start); | ||
| VERIFY_ARE_EQUAL(degenerate ? origin : writeTarget, utr->_end); | ||
| } | ||
| else if (textUnit <= TextUnit::TextUnit_Line) | ||
| { | ||
| VERIFY_ARE_EQUAL(lastLineStart, utr->_start); | ||
| VERIFY_ARE_EQUAL(degenerate ? lastLineStart : endExclusive, utr->_end); | ||
| } | ||
| else // textUnit <= TextUnit::TextUnit_Document: | ||
| { | ||
| VERIFY_ARE_EQUAL(origin, utr->_start); | ||
| VERIFY_ARE_EQUAL(degenerate ? origin : endExclusive, utr->_end); | ||
|
There was a problem hiding this comment. i know it might be a chore, but having @codeofdusk review this test case for sanity would be helpful There was a problem hiding this comment. (a chore for him, not a chore for you. since this is a bunch of dense WEX C++) |
||
| } | ||
| } | ||
|
|
||
|
|
||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
is this the fix for the crash?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yup. In general, I thought it was only possible for
_endto be atEndExclusive(), soallowBottomExclusiveis used to track if we are working with_end. That definitely wasn't the case because you can end up with_startatEndExclusive()by doing the repro steps.So this check for
EndExclusive()is basically thrown around everywhere to ensure we don't crash on anIncrementInBoundsorDecrementInBoundscheck (which checks if the COORD is in the buffer, andEndExclusiveisn't)