Generalize helpers for indenting and prefixing #14517
Merged
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
cameel
commented
Aug 25, 2023
test/libsolidity/GasTest.cpp
Outdated
Comment on lines
156
to
168
| void GasTest::printSource(ostream& _stream, string const& _linePrefix, bool) const | ||
| { | ||
| string line; | ||
| istringstream input(m_source); | ||
| while (getline(input, line)) | ||
| _stream << _linePrefix << line << std::endl; | ||
| } |
There was a problem hiding this comment.
This is superfluous. The inherited version from TestCase does the same thing.
matheusaaguiar
previously approved these changes
Aug 31, 2023
cameel
force-pushed
the
indent-refactor
branch
2 times, most recently
from
e52a836 to
78212c1
Compare
cameel
force-pushed
the
indent-refactor
branch
from
78212c1 to
ed2ce61
Compare
cameel
force-pushed
the
indent-refactor
branch
3 times, most recently
from
6645e92 to
bef39cd
Compare
cameel
force-pushed
the
indent-refactor
branch
from
bef39cd to
58a765a
Compare
matheusaaguiar
approved these changes
Oct 13, 2023
cameel
force-pushed
the
indent-refactor
branch
from
58a765a to
b56e26a
Compare
| /// @param _trimPrefix If true, the function avoids introducing trailing whitespace on empty lines. | ||
| /// This is achieved by removing trailing spaces from the prefix on such lines. | ||
| /// Note that tabs and newlines are not removed, only spaces are. | ||
| /// @param _finalNewline If true, an extra \n will be printed at the end of @a _input if it does |
There was a problem hiding this comment.
Suggested change
| /// @param _finalNewline If true, an extra \n will be printed at the end of @a _input if it does | |
| /// @param _finalNewline If true, an extra \n will be printed at the end of @_input if it does |
There was a problem hiding this comment.
What? Is this even a correct doxygen syntax? I think that @ must be followed by a command name.
Well, not that we're following this strictly, but still, this seems incorrect.
| /// such lines containing trailing whitespace. | ||
| inline std::string indent(std::string const& _input, bool _indentEmptyLines = false) | ||
| { | ||
| return prefixLines(_input, " ", !_indentEmptyLines); |
There was a problem hiding this comment.
Suggested change
| return prefixLines(_input, " ", !_indentEmptyLines); | |
| return prefixLines(_input, std::string(4, ' '), !_indentEmptyLines); |
I think it's clearer this way, at least with regards to the number of spaces in the indentation.
There was a problem hiding this comment.
I don't mind either way, but the PR is merged now so I'll leave it as is (the comment was posted while the PR was already on automerge and I did not notice it in time).
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.
Another refactor related to #14433.
This one comes from the fact that at one point I needed a function to indent a chunk of output and I found several, neither of them accessible to me.
In the end I changed the way expectations are formatted and did not need that function (which is why #14506 does not depend on this refactor) but since I already cleaned this up, I think we should still merge it.