[clang] [AST] Iterate redecls starting from the canonical one in getRawCommentsForAnyRedecl() (PR #108475)
Younan Zhang via cfe-commits
cfe-commits at lists.llvm.org
Wed Sep 18 23:03:30 PDT 2024
================
@@ -0,0 +1,99 @@
+//===- 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) {}
+ ~Consumer() override {}
+
+ 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();
+ }
----------------
zyn0217 wrote:
We might want to handle *TemplateDecls too, but it is not required as we don't actually need them now.
https://github.com/llvm/llvm-project/pull/108475
More information about the cfe-commits
mailing list