Handle ANSI escape sequences when performing column wrapping #2849
Conversation
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
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## devel #2849 +/- ##
==========================================
- Coverage 91.17% 91.10% -0.07%
==========================================
Files 197 198 +1
Lines 8379 8493 +114
==========================================
+ Hits 7639 7737 +98
- Misses 740 756 +16 |
horenmar
reviewed
Apr 9, 2024
| std::string const& current_line = m_column.m_string; | ||
| if ( m_lineStart < current_line.size() && current_line[m_lineStart] == '\n' ) { | ||
| m_lineStart += 1; | ||
| m_lineStart = m_lineEnd; // FIXME |
There was a problem hiding this comment.
I believe this is resolved now and I just forgot to remove the comment
horenmar
reviewed
Apr 9, 2024
| // constant value" warning on MSVC | ||
| static constexpr char sentinel = static_cast<char>( 0xffu ); | ||
|
|
||
| AnsiSkippingString( std::string const& text ); |
There was a problem hiding this comment.
This needs a move overload as well.
horenmar
reviewed
Apr 9, 2024
| } | ||
| } | ||
|
|
||
| std::string Column::const_iterator::operator*() const { | ||
| assert( m_lineStart <= m_parsedTo ); | ||
| return addIndentAndSuffix( m_lineStart, m_lineLength ); | ||
| // assert( m_lineStart <= m_parsedTo ); |
There was a problem hiding this comment.
This shouldn't be commented out.
horenmar
reviewed
Apr 9, 2024
horenmar
reviewed
Apr 9, 2024
|
Thank you for reviewing, I've updated to address the review comments |
…lete ansi escape sequences
|
thanks |
|
Thank you so much! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Description
This PR adds functionality to skip around ANSI escape sequences in catch_textflow so they do not contribute to line length and line wrapping code does not split escape sequences in the middle. I've implemented this by creating a
AnsiSkippingStringabstraction that has a bidirectional iterator that can skip around escape sequences while iterating. Additionally I refactoredColumn::const_iteratorto be iterator-based rather than index-based so this abstraction is a simple drop-in forstd::string.Currently only color sequences are handled, other escape sequences are left unaffected.
Motivation: Text with ANSI color sequences gets messed up when being output by Catch2 #2833.
For example, the current behavior of string with lots of escapes:
The example I have handy is a syntax-highlighted assertion from another library.
Behavior with this PR:
GitHub Issues
Closes #2833