-
Notifications
You must be signed in to change notification settings - Fork 20
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Let Location::str() handle \r
correctly
#127
Conversation
\r\n
and co correctly\r
correctly
Based on meeting feedback, this new version hardens Because I was exhaustively testing and found a lot of edge cases, I rewrote most of Location::str() in order more fundamentally satisfy the testing requirements. Let me know if there are any questions/clarifications/requests. |
|
||
std::string escape_string(const std::string str) | ||
{ | ||
std::string result; |
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.
Nit: this should be a string stream.
This PR is split off from #126, because really it's an orthogonal fix.
The observed problem was that, on Windows, error messages had a strange
\r
in reported source locations that was inconsistent with both other platforms, and other parts of the same output string (you would see\n
once then\r\n
further along the same string).The trouble was traced back to
source.h
, which was separating lines based on only the\n
character, and assuming that line breaks were only 1 char wide. This PR rewrites the 3 line/columns handling functions that did this, so that they will accept\r\n
,\n
, and\r
as line delimiters while reporting correct line lengths (and so forth) on all platforms.The main change of substance is that the
lines
field ofSourceDef
changes from a vector ofsize_t
to a vector ofpair<size_t, size_t>
, because it is no longer possible to derive where a line ends from where another line begins (we might have to add/subtract either 1 or 2 chars). Rather than try to detect some file-wide line break width (and possibly have problems due to corrupted files mixing line ending types), this rewrite just looks at which line ending variant each line had and records span information to match.Additionally, this PR adds exhaustive generative testing of this changed feature.
The test code is commented to explain logically how it builds all possible permutations of line endings and line contents up to a certain length (albeit using just
a
as contents since this code is not sensitive to string contents).As configured in the
CMakeLists.txt
, it runs 729 test cases up to length 6 (6 chars, 6 line endings, and everything in between).This fine-grained testing should help keep this code robust if it ever needs to change again - in fact it already helped catch errors when implementing some review recommendations from the other PR this was split from.