-
-
Notifications
You must be signed in to change notification settings - Fork 537
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
Verbatim strings #535
Merged
Merged
Verbatim strings #535
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
Using example from XAMPPRocky#330, for testing purposes
Rust test case now has a verbatim string that fails, with current version of Tokei.
C++ Syntax makes this incredibly difficult to parse using the current infrastructure, `R"PREFIX( )PREFIX"` where PREFIX can be almost anything.
Quotes that neglect the `\"` rule, in the case of python as mentioned in XAMPPRocky#330 it produces the correct outcome with Tokei currently.
Properly keeps track of current state and handles escapes properly in the case of being inside of a verbatim_quote
CI pipeline timeout when trying to download a dependency, going to blank commit in order to re-trigger the pipeline. |
@XAMPPRocky should be ready for review now 😄 |
Thank you for your PR! |
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.
Closes #330
Adds support for verbatim strings in
Rust
,CSharp
,FSharp
, andC++
. This should be easy enough to add for any other languages in the future. The only weird case for future contributors, here is thatPython
behaves correctly in the current implementation of Tokei and would behave incorrectly in the case of verbatim strings.Issues
Rust
The Rust implementation is fairly naive, ideally
languages.json
would have a regex/r(#+)"/
, but the dependency on theregex
crate would add a good chunk to the compile time and would hurt performance, as mentioned in your comment the most common types are implemented here.C++
I should've seen this coming,
C++
is incredibly annoying for verbatim strings, the syntax of"PREFIX()PREFIX"
wherePREFIX
can basically be anything. This would ideally be a regular expression as well. An emptyPREFIX
appears to be the most common situation so that's currently what's implemented. It appears thatscc
doesn't work properly for this either as both bare()
s and prefixed ones produce incorrect results.Any advice/feedback is greatly appreciated 😄