-
Notifications
You must be signed in to change notification settings - Fork 11.6k
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
[AST] Ensure getRawCommentsForAnyRedecl() does not miss any redecl with a comment #108475
Merged
+119
−4
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
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
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,98 @@ | ||
//===- unittests/AST/RawCommentForDeclTestTest.cpp | ||
//-------------------------===// | ||
// | ||
// Part of the LLVM Project, under the Apache License v2.0 with LLVM Exceptions. | ||
// See https://llvm.org/LICENSE.txt for license information. | ||
// SPDX-License-Identifier: Apache-2.0 WITH LLVM-exception | ||
// | ||
//===----------------------------------------------------------------------===// | ||
|
||
#include "clang/AST/ASTConsumer.h" | ||
#include "clang/AST/DeclGroup.h" | ||
#include "clang/Frontend/CompilerInstance.h" | ||
#include "clang/Frontend/FrontendAction.h" | ||
#include "clang/Tooling/Tooling.h" | ||
|
||
#include "gmock/gmock-matchers.h" | ||
#include "gtest/gtest.h" | ||
|
||
namespace clang { | ||
|
||
struct FoundComment { | ||
std::string DeclName; | ||
bool IsDefinition; | ||
std::string Comment; | ||
|
||
bool operator==(const FoundComment &RHS) const { | ||
return DeclName == RHS.DeclName && IsDefinition == RHS.IsDefinition && | ||
Comment == RHS.Comment; | ||
} | ||
friend llvm::raw_ostream &operator<<(llvm::raw_ostream &Stream, | ||
const FoundComment &C) { | ||
return Stream << "{Name: " << C.DeclName << ", Def: " << C.IsDefinition | ||
<< ", Comment: " << C.Comment << "}"; | ||
} | ||
}; | ||
|
||
class CollectCommentsAction : public ASTFrontendAction { | ||
public: | ||
CollectCommentsAction(std::vector<FoundComment> &Comments) | ||
: Comments(Comments) {} | ||
|
||
std::unique_ptr<ASTConsumer> CreateASTConsumer(CompilerInstance &CI, | ||
llvm::StringRef) override { | ||
CI.getLangOpts().CommentOpts.ParseAllComments = true; | ||
return std::make_unique<Consumer>(*this); | ||
} | ||
|
||
std::vector<FoundComment> &Comments; | ||
|
||
private: | ||
class Consumer : public clang::ASTConsumer { | ||
private: | ||
CollectCommentsAction &Action; | ||
|
||
public: | ||
Consumer(CollectCommentsAction &Action) : Action(Action) {} | ||
|
||
bool HandleTopLevelDecl(DeclGroupRef DG) override { | ||
for (Decl *D : DG) { | ||
if (NamedDecl *ND = dyn_cast<NamedDecl>(D)) { | ||
auto &Ctx = D->getASTContext(); | ||
const auto *RC = Ctx.getRawCommentForAnyRedecl(D); | ||
Action.Comments.push_back(FoundComment{ | ||
ND->getNameAsString(), IsDefinition(D), | ||
RC ? RC->getRawText(Ctx.getSourceManager()).str() : ""}); | ||
} | ||
} | ||
|
||
return true; | ||
} | ||
|
||
static bool IsDefinition(const Decl *D) { | ||
if (const FunctionDecl *FD = dyn_cast<FunctionDecl>(D)) { | ||
return FD->isThisDeclarationADefinition(); | ||
} | ||
if (const TagDecl *TD = dyn_cast<TagDecl>(D)) { | ||
return TD->isThisDeclarationADefinition(); | ||
} | ||
return false; | ||
} | ||
}; | ||
}; | ||
|
||
TEST(RawCommentForDecl, DefinitionComment) { | ||
std::vector<FoundComment> Comments; | ||
auto Action = std::make_unique<CollectCommentsAction>(Comments); | ||
ASSERT_TRUE(tooling::runToolOnCode(std::move(Action), R"cpp( | ||
void f(); | ||
|
||
// f is the best | ||
void f() {} | ||
)cpp")); | ||
EXPECT_THAT(Comments, testing::ElementsAre( | ||
FoundComment{"f", false, ""}, | ||
FoundComment{"f", true, "// f is the best"})); | ||
} | ||
|
||
} // namespace clang |
Oops, something went wrong.
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.
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.
We might want to handle *TemplateDecls too, but it is not required as we don't actually need them now.