review: feat: Make sniper printer infer indentation style of compilation unit #3717
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
slarse
commented
Dec 3, 2020
Comment on lines
+35
to
+56
| private class SniperPrinterHelper extends PrinterHelper { | ||
| private final Environment env; | ||
|
|
||
| SniperPrinterHelper(Environment env) { | ||
| super(env); | ||
| this.env = env; | ||
| } | ||
|
|
||
| /** | ||
| * We override this method to use the correct style of indentation for new elements. | ||
| */ | ||
| @Override | ||
| protected void autoWriteTabs() { | ||
| int setTabulationSize = env.getTabulationSize(); | ||
| env.useTabulations(originSourceUsesTabulations); | ||
| env.setTabulationSize(originSourceTabulationSize); | ||
|
|
||
| super.autoWriteTabs(); | ||
|
|
||
| env.setTabulationSize(setTabulationSize); | ||
| env.useTabulations(true); | ||
| } |
There was a problem hiding this comment.
This is the actual thing that overrides the printing of tabs with whatever indentation style is present in the source file. I'm not completely satisfied with this solution as it seems a bit hacky, but I couldn't figure out a better way to do it. Suggestions are welcome.
slarse
commented
Dec 3, 2020
Comment on lines
+139
to
+141
| Pair<Integer, Boolean> indentationInfo = IndentationDetector.detectIndentation(compilationUnit); | ||
| mutableTokenWriter.setOriginSourceTabulationSize(indentationInfo.getLeft()); | ||
| mutableTokenWriter.setOriginSourceUsesTabulations(indentationInfo.getRight()); |
There was a problem hiding this comment.
The token writer is updated with indentation style for each CU to be printed.
|
Ping @nharrand |
nharrand
reviewed
Dec 4, 2020
|
LGTM! If you can just add a comment on the description of |
|
@nharrand Done! Now just waiting for CI. |
|
Thanks for the PR @slarse ! |
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.
Fix #3715
This PR introduces indentation style inference to the sniper printer. It's simple in principle: look at the whitespace preceding the top-level type members and make a best guess as to what the indentation style is out of 1, 2 or 4 spaces/tabs. The original set of source code fragments are used to detect indentation.
If for any given compilation unit no top-level elements can be found, indentation detection defaults to tabs.
We will start using this ASAP in Sorald, preferably with the new beta release this Saturday if we can get it merged by then. Therefore, we should be able to detect any obvious issues this might introduce relatively quickly.
Note: This will crash and burn if you try to sniper print a compilation unit that does not have an origin source (e.g. if you add a CU through the Spoon API). That appears to be the case before this addition as well. Just thought I'd make note of it.