Skip to content

[clangd] Add tweak to add pure virtual overrides #139348

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

Copy link

Thank you for submitting a Pull Request (PR) to the LLVM Project!

This PR will be automatically labeled and the relevant teams will be notified.

If you wish to, you can add reviewers by using the "Reviewers" section on this page.

If this is not working for you, it is probably because you do not have write permissions for the repository. In which case you can instead tag reviewers by name in a comment by using @ followed by their GitHub username.

If you have received no comments on your PR for a week, you can request a review by "ping"ing the PR by adding a comment “Ping”. The common courtesy "ping" rate is once a week. Please remember that you are asking for valuable time from other developers.

If you have further questions, they may be answered by the LLVM GitHub User Guide.

You can also ask questions in a comment on this PR, on the LLVM Discord or on the forums.

@llvmbot
Copy link
Member

llvmbot commented May 10, 2025

@llvm/pr-subscribers-clang-tools-extra

@llvm/pr-subscribers-clangd

Author: Marco Maia (marcogmaia)

Changes

This PR solves the following:


Patch is 24.57 KiB, truncated to 20.00 KiB below, full version: https://github.com/llvm/llvm-project/pull/139348.diff

4 Files Affected:

  • (modified) clang-tools-extra/clangd/refactor/tweaks/CMakeLists.txt (+2-1)
  • (added) clang-tools-extra/clangd/refactor/tweaks/OverridePureVirtuals.cpp (+366)
  • (modified) clang-tools-extra/clangd/unittests/CMakeLists.txt (+1)
  • (added) clang-tools-extra/clangd/unittests/tweaks/OverridePureVirtualsTests.cpp (+410)
diff --git a/clang-tools-extra/clangd/refactor/tweaks/CMakeLists.txt b/clang-tools-extra/clangd/refactor/tweaks/CMakeLists.txt
index 59475b0dfd3d2..1d6e38088ad67 100644
--- a/clang-tools-extra/clangd/refactor/tweaks/CMakeLists.txt
+++ b/clang-tools-extra/clangd/refactor/tweaks/CMakeLists.txt
@@ -14,9 +14,9 @@ set(LLVM_LINK_COMPONENTS
 add_clang_library(clangDaemonTweaks OBJECT
   AddUsing.cpp
   AnnotateHighlightings.cpp
-  DumpAST.cpp
   DefineInline.cpp
   DefineOutline.cpp
+  DumpAST.cpp
   ExpandDeducedType.cpp
   ExpandMacro.cpp
   ExtractFunction.cpp
@@ -24,6 +24,7 @@ add_clang_library(clangDaemonTweaks OBJECT
   MemberwiseConstructor.cpp
   ObjCLocalizeStringLiteral.cpp
   ObjCMemberwiseInitializer.cpp
+  OverridePureVirtuals.cpp
   PopulateSwitch.cpp
   RawStringLiteral.cpp
   RemoveUsingNamespace.cpp
diff --git a/clang-tools-extra/clangd/refactor/tweaks/OverridePureVirtuals.cpp b/clang-tools-extra/clangd/refactor/tweaks/OverridePureVirtuals.cpp
new file mode 100644
index 0000000000000..b8880433fdd52
--- /dev/null
+++ b/clang-tools-extra/clangd/refactor/tweaks/OverridePureVirtuals.cpp
@@ -0,0 +1,366 @@
+//===--- AddPureVirtualOverride.cpp ------------------------------*- C++-*-===//
+//
+// 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 "refactor/Tweak.h"
+
+#include "clang/AST/ASTContext.h"
+#include "clang/AST/DeclCXX.h"
+#include "clang/AST/Type.h"
+#include "clang/AST/TypeLoc.h"
+#include "clang/Basic/LLVM.h"
+#include "clang/Basic/SourceLocation.h"
+#include "clang/Tooling/Core/Replacement.h"
+#include "llvm/ADT/DenseSet.h"
+#include "llvm/Support/FormatVariadic.h"
+#include <algorithm>
+#include <functional>
+#include <map>
+#include <set>
+#include <string>
+#include <vector>
+
+namespace clang {
+namespace clangd {
+namespace {
+
+class OverridePureVirtuals : public Tweak {
+public:
+  const char *id() const final; // defined by REGISTER_TWEAK.
+  bool prepare(const Selection &Sel) override;
+  Expected<Effect> apply(const Selection &Sel) override;
+  std::string title() const override { return "Override pure virtual methods"; }
+  llvm::StringLiteral kind() const override {
+    return CodeAction::REFACTOR_KIND;
+  }
+
+private:
+  // Stores the CXXRecordDecl of the class being modified.
+  const CXXRecordDecl *CurrentDecl = nullptr;
+  // Stores pure virtual methods that need overriding, grouped by their original
+  // access specifier.
+  std::map<AccessSpecifier, std::vector<const CXXMethodDecl *>>
+      MissingMethodsByAccess;
+  // Stores the source locations of existing access specifiers in CurrentDecl.
+  std::map<AccessSpecifier, SourceLocation> AccessSpecifierLocations;
+
+  // Helper function to gather information before applying the tweak.
+  void collectMissingPureVirtuals(const Selection &Sel);
+};
+
+REGISTER_TWEAK(OverridePureVirtuals)
+
+// Collects all unique, canonical pure virtual methods from a class and its
+// entire inheritance hierarchy. This function aims to find methods that *could*
+// make a derived class abstract if not implemented.
+std::vector<const CXXMethodDecl *>
+getAllUniquePureVirtualsFromHierarchy(const CXXRecordDecl *Decl) {
+  std::vector<const CXXMethodDecl *> Result;
+  llvm::DenseSet<const CXXMethodDecl *> VisitedCanonicalMethods;
+  // We declare it as a std::function because we are going to call it
+  // recursively.
+  std::function<void(const CXXRecordDecl *)> Collect;
+
+  Collect = [&](const CXXRecordDecl *CurrentClass) {
+    if (!CurrentClass) {
+      return;
+    }
+    const CXXRecordDecl *Def = CurrentClass->getDefinition();
+    if (!Def) {
+      return;
+    }
+
+    for (const CXXMethodDecl *M : Def->methods()) {
+      // Add if its canonical declaration hasn't been processed yet.
+      // This ensures each distinct pure virtual method signature is collected
+      // once.
+      if (M->isPureVirtual() &&
+          VisitedCanonicalMethods.insert(M->getCanonicalDecl()).second) {
+        Result.emplace_back(M); // Store the specific declaration encountered.
+      }
+    }
+
+    for (const auto &BaseSpec : Def->bases()) {
+      if (const CXXRecordDecl *BaseDef =
+              BaseSpec.getType()->getAsCXXRecordDecl()) {
+        Collect(BaseDef); // Recursively collect from base classes.
+      }
+    }
+  };
+
+  Collect(Decl);
+  return Result;
+}
+
+// Gets canonical declarations of methods already overridden or implemented in
+// class D.
+std::set<const CXXMethodDecl *>
+getImplementedOrOverriddenCanonicals(const CXXRecordDecl *D) {
+  std::set<const CXXMethodDecl *> ImplementedSet;
+  for (const CXXMethodDecl *M : D->methods()) {
+    // If M provides an implementation for any virtual method it overrides.
+    // A method is an "implementation" if it's virtual and not pure.
+    // Or if it directly overrides a base method.
+    for (const CXXMethodDecl *OverriddenM : M->overridden_methods()) {
+      ImplementedSet.insert(OverriddenM->getCanonicalDecl());
+    }
+  }
+  return ImplementedSet;
+}
+
+// Get the location of every colon of the `AccessSpecifier`.
+std::map<AccessSpecifier, SourceLocation>
+getSpecifierLocations(const CXXRecordDecl *D) {
+  std::map<AccessSpecifier, SourceLocation> Locs;
+  for (auto *DeclNode : D->decls()) { // Changed to DeclNode to avoid ambiguity
+    if (const auto *ASD = llvm::dyn_cast<AccessSpecDecl>(DeclNode)) {
+      Locs[ASD->getAccess()] = ASD->getColonLoc();
+    }
+  }
+  return Locs;
+}
+
+// Check if the current class has any pure virtual method to be implemented.
+bool OverridePureVirtuals::prepare(const Selection &Sel) {
+  const SelectionTree::Node *Node = Sel.ASTSelection.commonAncestor();
+  if (!Node) {
+    return false;
+  }
+
+  // Make sure we have a definition.
+  CurrentDecl = Node->ASTNode.get<CXXRecordDecl>();
+  if (!CurrentDecl || !CurrentDecl->getDefinition()) {
+    return false;
+  }
+
+  // A class needs overrides if it's abstract itself, or derives from abstract
+  // bases and hasn't implemented all necessary methods. A simpler check: if it
+  // has any base that is abstract.
+  bool HasAbstractBase = false;
+  for (const auto &Base : CurrentDecl->bases()) {
+    if (const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl()) {
+      if (BaseDecl->getDefinition() &&
+          BaseDecl->getDefinition()->isAbstract()) {
+        HasAbstractBase = true;
+        break;
+      }
+    }
+  }
+
+  // Only offer for polymorphic classes with abstract bases.
+  return CurrentDecl->isPolymorphic() && HasAbstractBase;
+}
+
+// Collects all pure virtual methods that are missing an override in
+// CurrentDecl, grouped by their original access specifier.
+void OverridePureVirtuals::collectMissingPureVirtuals(const Selection &Sel) {
+  if (!CurrentDecl)
+    return;
+  CurrentDecl = CurrentDecl->getDefinition(); // Work with the definition
+  if (!CurrentDecl)
+    return;
+
+  AccessSpecifierLocations = getSpecifierLocations(CurrentDecl);
+  MissingMethodsByAccess.clear();
+
+  // Get all unique pure virtual methods from the entire base class hierarchy.
+  std::vector<const CXXMethodDecl *> AllPureVirtualsInHierarchy;
+  llvm::DenseSet<const CXXMethodDecl *> CanonicalPureVirtualsSeen;
+
+  for (const auto &BaseSpec : CurrentDecl->bases()) {
+    if (const CXXRecordDecl *BaseRD =
+            BaseSpec.getType()->getAsCXXRecordDecl()) {
+      const CXXRecordDecl *BaseDef = BaseRD->getDefinition();
+      if (!BaseDef)
+        continue;
+
+      std::vector<const CXXMethodDecl *> PuresFromBasePath =
+          getAllUniquePureVirtualsFromHierarchy(BaseDef);
+      for (const CXXMethodDecl *M : PuresFromBasePath) {
+        if (CanonicalPureVirtualsSeen.insert(M->getCanonicalDecl()).second) {
+          AllPureVirtualsInHierarchy.emplace_back(M);
+        }
+      }
+    }
+  }
+
+  // Get methods already implemented or overridden in CurrentDecl.
+  const auto ImplementedOrOverriddenSet =
+      getImplementedOrOverriddenCanonicals(CurrentDecl);
+
+  // Filter AllPureVirtualsInHierarchy to find those not in
+  // ImplementedOrOverriddenSet.
+  for (const CXXMethodDecl *BaseMethod : AllPureVirtualsInHierarchy) {
+    bool AlreadyHandled =
+        ImplementedOrOverriddenSet.count(BaseMethod->getCanonicalDecl()) > 0;
+
+    if (!AlreadyHandled) {
+      // This method needs an override.
+      // Group it by its access specifier in its defining class.
+      MissingMethodsByAccess[BaseMethod->getAccess()].emplace_back(BaseMethod);
+    }
+  }
+}
+
+// Free function to generate the string for a group of method overrides.
+std::string
+generateOverridesStringForGroup(std::vector<const CXXMethodDecl *> Methods,
+                                const LangOptions &LangOpts) {
+  const auto GetParamString = [&LangOpts](const ParmVarDecl *P) {
+    std::string TypeStr = P->getType().getAsString(LangOpts);
+    if (P->getNameAsString().empty()) {
+      // Unnamed parameter.
+      return TypeStr;
+    }
+    return llvm::formatv("{0} {1}", TypeStr, P->getNameAsString()).str();
+  };
+
+  std::string MethodsString;
+  for (const auto *Method : Methods) {
+    std::vector<std::string> ParamsAsString;
+    ParamsAsString.reserve(Method->parameters().size());
+    std::transform(Method->param_begin(), Method->param_end(),
+                   std::back_inserter(ParamsAsString), GetParamString);
+    const auto Params = llvm::join(ParamsAsString, ", ");
+
+    MethodsString +=
+        llvm::formatv(
+            "  {0} {1}({2}) {3}override {{\n"
+            "    // TODO: Implement this pure virtual method\n"
+            "    static_assert(false, \"Method `{1}` is not implemented.\");\n"
+            "  }\n",
+            Method->getReturnType().getAsString(LangOpts),
+            Method->getNameAsString(), Params,
+            std::string(Method->isConst() ? "const " : ""))
+            .str();
+  }
+  return MethodsString;
+}
+
+// Helper to get the string spelling of an AccessSpecifier.
+std::string getAccessSpecifierSpelling(AccessSpecifier AS) {
+  switch (AS) {
+  case AS_public:
+    return "public";
+  case AS_protected:
+    return "protected";
+  case AS_private:
+    return "private";
+  case AS_none:
+    // Should not typically occur for class members.
+    return "";
+  }
+  // Unreachable.
+  return "";
+}
+
+Expected<Tweak::Effect> OverridePureVirtuals::apply(const Selection &Sel) {
+  // The correctness of this tweak heavily relies on the accurate population of
+  // these members.
+  collectMissingPureVirtuals(Sel);
+
+  if (MissingMethodsByAccess.empty()) {
+    return llvm::make_error<llvm::StringError>(
+        "No pure virtual methods to override.", llvm::inconvertibleErrorCode());
+  }
+
+  const auto &SM = Sel.AST->getSourceManager();
+  const auto &LangOpts = Sel.AST->getLangOpts();
+
+  tooling::Replacements EditReplacements;
+  // Stores text for new access specifier sections // that are not already
+  // present in the class.
+  // Example:
+  //  public:    // ...
+  //  protected: // ...
+  std::string NewSectionsToAppendText;
+  // Tracks if we are adding the first new access section
+  // to NewSectionsToAppendText, to manage preceding newlines.
+  bool IsFirstNewSection = true;
+
+  // Define the order in which access specifiers should be processed and
+  // potentially added.
+  constexpr auto AccessOrder = std::array{
+      AccessSpecifier::AS_public,
+      AccessSpecifier::AS_protected,
+      AccessSpecifier::AS_private,
+  };
+
+  for (AccessSpecifier AS : AccessOrder) {
+    auto GroupIter = MissingMethodsByAccess.find(AS);
+    // Check if there are any missing methods for the current access specifier.
+    if (GroupIter == MissingMethodsByAccess.end() ||
+        GroupIter->second.empty()) {
+      // No methods to override for this access specifier.
+      continue;
+    }
+
+    std::string MethodsGroupString =
+        generateOverridesStringForGroup(GroupIter->second, LangOpts);
+
+    auto ExistingSpecLocIter = AccessSpecifierLocations.find(AS);
+    if (ExistingSpecLocIter != AccessSpecifierLocations.end()) {
+      // Access specifier section already exists in the class.
+      // Get location immediately *after* the colon.
+      SourceLocation InsertLoc =
+          ExistingSpecLocIter->second.getLocWithOffset(1);
+
+      // Create a replacement to insert the method declarations.
+      // The replacement is at InsertLoc, has length 0 (insertion), and uses
+      // InsertionText.
+      std::string InsertionText = "\n" + MethodsGroupString;
+      tooling::Replacement Rep(SM, InsertLoc, 0, InsertionText);
+      if (auto Err = EditReplacements.add(Rep)) {
+        // Handle error if replacement couldn't be added (e.g. overlaps)
+        return llvm::Expected<Tweak::Effect>(std::move(Err));
+      }
+    } else {
+      // Access specifier section does not exist in the class.
+      // These methods will be grouped into NewSectionsToAppendText and added
+      // towards the end of the class definition.
+      if (!IsFirstNewSection) {
+        NewSectionsToAppendText += "\n";
+      }
+      NewSectionsToAppendText +=
+          getAccessSpecifierSpelling(AS) + ":\n" + MethodsGroupString;
+      IsFirstNewSection = false;
+    }
+  }
+
+  // After processing all access specifiers, add any newly created sections
+  // (stored in NewSectionsToAppendText) to the end of the class.
+  if (!NewSectionsToAppendText.empty()) {
+    // AppendLoc is the SourceLocation of the closing brace '}' of the class.
+    // The replacement will insert text *before* this closing brace.
+    SourceLocation AppendLoc = CurrentDecl->getBraceRange().getEnd();
+    std::string FinalAppendText = NewSectionsToAppendText;
+
+    if (!CurrentDecl->decls_empty() || !EditReplacements.empty()) {
+      FinalAppendText = "\n" + FinalAppendText;
+    }
+
+    // Create a replacement to append the new sections.
+    tooling::Replacement Rep(SM, AppendLoc, 0, FinalAppendText);
+    if (auto Err = EditReplacements.add(Rep)) {
+      // Handle error if replacement couldn't be added
+      return llvm::Expected<Tweak::Effect>(std::move(Err));
+    }
+  }
+
+  if (EditReplacements.empty()) {
+    return llvm::make_error<llvm::StringError>(
+        "No changes to apply (internal error or no methods generated).",
+        llvm::inconvertibleErrorCode());
+  }
+
+  // Return the collected replacements as the effect of this tweak.
+  return Effect::mainFileEdit(SM, EditReplacements);
+}
+
+} // namespace
+} // namespace clangd
+} // namespace clang
diff --git a/clang-tools-extra/clangd/unittests/CMakeLists.txt b/clang-tools-extra/clangd/unittests/CMakeLists.txt
index dffdcd5d014ca..d425070c7f3b7 100644
--- a/clang-tools-extra/clangd/unittests/CMakeLists.txt
+++ b/clang-tools-extra/clangd/unittests/CMakeLists.txt
@@ -131,6 +131,7 @@ add_unittest(ClangdUnitTests ClangdTests
   tweaks/MemberwiseConstructorTests.cpp
   tweaks/ObjCLocalizeStringLiteralTests.cpp
   tweaks/ObjCMemberwiseInitializerTests.cpp
+  tweaks/OverridePureVirtualsTests.cpp
   tweaks/PopulateSwitchTests.cpp
   tweaks/RawStringLiteralTests.cpp
   tweaks/RemoveUsingNamespaceTests.cpp
diff --git a/clang-tools-extra/clangd/unittests/tweaks/OverridePureVirtualsTests.cpp b/clang-tools-extra/clangd/unittests/tweaks/OverridePureVirtualsTests.cpp
new file mode 100644
index 0000000000000..4b8518cf62209
--- /dev/null
+++ b/clang-tools-extra/clangd/unittests/tweaks/OverridePureVirtualsTests.cpp
@@ -0,0 +1,410 @@
+//===-- AddPureVirtualOverrideTest.cpp --------------------------*- C++ -*-===//
+//
+// 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 "TweakTesting.h"
+#include "gtest/gtest.h"
+
+namespace clang {
+namespace clangd {
+namespace {
+
+class OverridePureVirtualsTest : public TweakTest {
+protected:
+  OverridePureVirtualsTest() : TweakTest("OverridePureVirtuals") {}
+};
+
+TEST_F(OverridePureVirtualsTest, MinimalUnavailable) {
+  EXPECT_UNAVAILABLE("class ^C {};");
+}
+
+TEST_F(OverridePureVirtualsTest, MinimalAvailable) {
+  EXPECT_AVAILABLE(R"cpp(
+class B { public: virtual void Foo() = 0; };
+class ^C : public B {};
+)cpp");
+}
+
+TEST_F(OverridePureVirtualsTest, Availability) {
+  EXPECT_AVAILABLE(R"cpp(
+class Base {
+public:
+virtual ~Base() = default;
+virtual void F1() = 0;
+virtual void F2() = 0;
+};
+
+class ^Derived : public Base {
+public:
+};
+
+)cpp");
+
+  EXPECT_AVAILABLE(R"cpp(
+class Base {
+public:
+virtual ~Base() = default;
+virtual void F1() = 0;
+virtual void F2() = 0;
+};
+
+class ^Derived : public Base {
+public:
+void F1() override;
+};
+)cpp");
+}
+
+TEST_F(OverridePureVirtualsTest, EmptyDerivedClass) {
+  const char *Before = R"cpp(
+class Base {
+public:
+virtual ~Base() = default;
+virtual void F1() = 0;
+virtual void F2(int P1, const int &P2) = 0;
+};
+
+class ^Derived : public Base {};
+)cpp";
+  const auto *Expected = R"cpp(
+class Base {
+public:
+virtual ~Base() = default;
+virtual void F1() = 0;
+virtual void F2(int P1, const int &P2) = 0;
+};
+
+class Derived : public Base {
+public:
+  void F1() override {
+    // TODO: Implement this pure virtual method
+    static_assert(false, "Method `F1` is not implemented.");
+  }
+  void F2(int P1, const int & P2) override {
+    // TODO: Implement this pure virtual method
+    static_assert(false, "Method `F2` is not implemented.");
+  }
+};
+)cpp";
+  auto Applied = apply(Before);
+  EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied;
+}
+
+TEST_F(OverridePureVirtualsTest, SingleBaseClassPartiallyImplemented) {
+  auto Applied = apply(
+      R"cpp(
+class Base {
+public:
+virtual ~Base() = default;
+virtual void F1() = 0;
+virtual void F2() = 0;
+};
+
+class ^Derived : public Base {
+public:
+  void F1() override;
+};
+)cpp");
+
+  const auto *Expected = R"cpp(
+class Base {
+public:
+virtual ~Base() = default;
+virtual void F1() = 0;
+virtual void F2() = 0;
+};
+
+class Derived : public Base {
+public:
+  void F2() override {
+    // TODO: Implement this pure virtual method
+    static_assert(false, "Method `F2` is not implemented.");
+  }
+
+  void F1() override;
+};
+)cpp";
+  EXPECT_EQ(Applied, Expected) << "Applied result:\n" << Applied;
+}
+
+TEST_F(OverridePureVirtualsTest, MultipleDirectBaseClasses) {
+  const char *Before = R"cpp(
+class Base1 {
+public:
+  virtual void func1() = 0;
+};
+class Base2 {
+protected:
+  virtual bool func2(char c) const = 0;
+};
+
+class ^Derived : public Base1, public Base2 {};
+)cpp";
+  const auto *Expected = R"cpp(
+class Base1 {
+public:
+  virtual void func1() = 0;
+};
+class Base2 {
+protected:
+  virtual bool func2(char c) const = 0;
+};
+
+class Derived : public Base1, public Base2 {
+public:
+  void func1() override {
+    // TODO: Implement this pure virtual method
+    static_assert(false, "Method `func1` is not implemented.");
+  }
+
+protected:
+  bool func2(char c) const override {
+    // TODO: Implement this pure virtual method
+    static_assert(false, "Method `func2` is not implemented.");
+  }
+};
+)cpp";
+  auto Applied = apply(Before);
+  EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied;
+}
+
+TEST_F(OverridePureVirtualsTest, UnnamedParametersInBase) {
+  const char *Before = R"cpp(
+struct S {};
+class Base {
+public:
+  virtual void func(int, const S&, char*) = 0;
+};
+
+class ^Derived : public Base {};
+)cpp";
+
+  const auto *Expected = R"cpp(
+struct S {};
+class Base {
+public:
+  virtual void func(int, const S&, char*) = 0;
+};
+
+class Derived : public Base {
+public:
+  void func(int, const S &, char *) override {
+    // TODO: Implement this pure virtual method
+    static_assert(false, "Method `func` is not implemented.");
+  }
+};
+)cpp";
+  auto Applied = apply(Before);
+  EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied;
+}
+
+TEST_F(OverridePureVirtualsTest, DiamondInheritance) {
+  const char *Before = R"cpp(
+class Top {
+public:
+  virtual ~Top() = default;
+  virtual void diamond_func() = 0;
+};
+class Left : virtual public Top {};
+class Right : virtual public Top {};
+class ^Bottom ...
[truncated]

@marcogmaia
Copy link
Author

@HighCommander4 could you please take a look here, or forward it to anyone who can?

Copy link
Contributor

@zyn0217 zyn0217 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a drive-by comment. Thanks for working on it

Comment on lines 245 to 259
std::string getAccessSpecifierSpelling(AccessSpecifier AS) {
switch (AS) {
case AS_public:
return "public";
case AS_protected:
return "protected";
case AS_private:
return "private";
case AS_none:
// Should not typically occur for class members.
return "";
}
// Unreachable.
return "";
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We have getAccessSpelling defined in clang/include/clang/Basic/Specifiers.h

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for pointing it out. I've changed it.

@zyn0217 zyn0217 requested a review from HighCommander4 May 10, 2025 11:37
Copy link
Contributor

@zwuis zwuis left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your work!

Please add a release note in clang-tools-extra/docs/ReleaseNotes.rst.

Please read https://llvm.org/docs/CodingStandards.html and follow requirements/suggestions in this document such as preferring llvm::SmallVector and not using braces on simple single-statement bodies of if statements.

Comment on lines +64 to +66
// We declare it as a std::function because we are going to call it
// recursively.
std::function<void(const CXXRecordDecl *)> Collect;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think declaring Collect as a function is better than an object with type std::function.

Comment on lines +143 to +152
bool HasAbstractBase = false;
for (const auto &Base : CurrentDecl->bases()) {
if (const CXXRecordDecl *BaseDecl = Base.getType()->getAsCXXRecordDecl()) {
if (BaseDecl->getDefinition() &&
BaseDecl->getDefinition()->isAbstract()) {
HasAbstractBase = true;
break;
}
}
}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use llvm::any_of defined in llvm/ADT/STLExtras.h.

// Unnamed parameter.
return TypeStr;
}
return llvm::formatv("{0} {1}", TypeStr, P->getNameAsString()).str();
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

std::move(TypeStr)

Comment on lines +226 to +227
std::transform(Method->param_begin(), Method->param_end(),
std::back_inserter(ParamsAsString), GetParamString);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can use llvm::transform defined in llvm/ADT/STLExtras.h.

" static_assert(false, \"Method `{1}` is not implemented.\");\n"
" }\n",
Method->getReturnType().getAsString(LangOpts),
Method->getNameAsString(), Params,
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

std::move(Params)

ParamsAsString.reserve(Method->parameters().size());
std::transform(Method->param_begin(), Method->param_end(),
std::back_inserter(ParamsAsString), GetParamString);
const auto Params = llvm::join(ParamsAsString, ", ");
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Remove const so that Params is actually moved below.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants