[SourceKit] Adjust newlines between decls #72553
Merged
Conversation
This file contains hidden or 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
rintaro
requested review from
ahoppen,
bnbarham,
hamishknight,
zoecarver,
hyp,
egorzhdan,
hborla,
slavapestov,
xedin and
tshortli
as code owners
rintaro
force-pushed
the
sourcekit-iterfacegen-newline
branch
from
188f748 to
72d7e8f
Compare
rintaro
commented
Mar 25, 2024
Comment on lines
-1137
to
1138
| // We want to print a newline before doc comments. Swift code already | ||
| // handles this, but we need to insert it for clang doc comments when not | ||
| // printing other clang comments. Do it now so the printDeclPre callback | ||
| // happens after the newline. | ||
| if (Options.PrintDocumentationComments && D->hasClangNode()) { | ||
| auto clangNode = D->getClangNode(); | ||
| auto clangDecl = clangNode.getAsDecl(); | ||
| if (clangDecl && | ||
| clangDecl->getASTContext().getRawCommentForAnyRedecl(clangDecl)) { | ||
| Printer.printNewline(); | ||
| indent(); | ||
| } | ||
| } | ||
|
|
||
| Printer.callPrintDeclPre(D, Options.BracketOptions); |
There was a problem hiding this comment.
This was leftover from generated interface printing normal comments between decls, which was hooking "PrintDeclPre". Not needed.
| if (D->print(Printer, Options)) { | ||
| if (Options.BracketOptions.shouldCloseNominal(D)) | ||
| Printer << "\n"; | ||
| Printer.printNewline(); |
There was a problem hiding this comment.
.printNewline() instead of << "\n" because that's ASTPrinter's style.
Comment on lines
697
to
+700
| for (auto CM : ClangModules) { | ||
| for (auto DeclAndLoc : ClangDecls[CM.first]) | ||
| PrintDecl(DeclAndLoc.first); | ||
| if (PrintDecl(DeclAndLoc.first) && Options.EmptyLineBetweenDecls) | ||
| Printer.printNewline(); |
There was a problem hiding this comment.
This is the main change of this PR. Newline after printing a decl just like Swift decls few lines below
| if (PrintDecl(D)) | ||
| Printer << "\n"; | ||
| if (PrintDecl(D) && Options.EmptyLineBetweenDecls) | ||
| Printer.printNewline(); |
There was a problem hiding this comment.
This makes swift-ide-test -print-interface NOT print newlines between top-level decls.
Currently EmptyLineBetweenDecls (formerly EmptyLineBetweenMembers) is enabled in generated-interface only.
|
@swift-ci Please smoke test |
Previously, Clang modules didn't have empty lines between top-level decls. This was inconsistent with Swift module.
rintaro
force-pushed
the
sourcekit-iterfacegen-newline
branch
from
72d7e8f to
7b3738d
Compare
|
@swift-ci Please smoke test |
ahoppen
approved these changes
Mar 25, 2024
hamishknight
approved these changes
Mar 25, 2024
tshortli
approved these changes
Mar 25, 2024
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.
Previously, generated interface for Clang modules didn't have empty lines between top-level decls. This was inconsistent with Swift modules.