Author: Qinkun Bao Date: 2025-07-23T22:54:20-04:00 New Revision: 3078029cec5f2b53ac171f29fa7dc96264dbe4bc
URL: https://github.com/llvm/llvm-project/commit/3078029cec5f2b53ac171f29fa7dc96264dbe4bc DIFF: https://github.com/llvm/llvm-project/commit/3078029cec5f2b53ac171f29fa7dc96264dbe4bc.diff LOG: Revert "[clangd] Add tweak to override pure virtuals (#139348)" This reverts commit 7355ea3f6b214d1569da43d02f9a166ff15012e6. Added: Modified: clang-tools-extra/clangd/refactor/tweaks/CMakeLists.txt clang-tools-extra/clangd/unittests/CMakeLists.txt clang-tools-extra/docs/ReleaseNotes.rst Removed: clang-tools-extra/clangd/refactor/tweaks/OverridePureVirtuals.cpp clang-tools-extra/clangd/unittests/tweaks/OverridePureVirtualsTests.cpp ################################################################################ diff --git a/clang-tools-extra/clangd/refactor/tweaks/CMakeLists.txt b/clang-tools-extra/clangd/refactor/tweaks/CMakeLists.txt index 1d6e38088ad67..59475b0dfd3d2 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,7 +24,6 @@ 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 deleted file mode 100644 index 16febeca70809..0000000000000 --- a/clang-tools-extra/clangd/refactor/tweaks/OverridePureVirtuals.cpp +++ /dev/null @@ -1,374 +0,0 @@ -//===--- OverridePureVirtuals.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 -// -//===----------------------------------------------------------------------===// -// -// Tweak to automatically generate stubs for pure virtual methods inherited from -// base classes. -// -// Purpose: -// - Simplifies making a derived class concrete by automating the creation of -// required method overrides from abstract bases. -// -// Tweak Summary: -// -// 1. Activation Conditions (prepare): -// - The tweak activates when the cursor is over a C++ class definition. -// - The class must be abstract (it, or its base classes, have unimplemented -// pure virtual functions). -// - It must also inherit from at least one other abstract class. -// -// 2. Identifying Missing Methods: -// - The tweak scans the inheritance hierarchy of the current class. -// - It identifies all unique pure virtual methods from base classes -// that are not yet implemented or overridden. -// - These missing methods are then grouped by their original access -// specifier (e.g., public, protected). -// -// 3. Code Generation and Insertion: -// - For each group of missing methods, stubs are inserted. -// - If an access specifier section (like `public:`) exists, stubs are -// inserted there; otherwise, a new section is created and appended. -// - Each generated stub includes the `override` keyword, a `// TODO:` -// comment, and a `static_assert(false, ...)` to force a compile-time -// error if the method remains unimplemented. -// - The base method's signature is adjusted (e.g., `virtual` and `= 0` -// are removed for the override). -// -// 4. Code Action Provided: -// - A single code action titled "Override pure virtual methods" is offered. -// - Applying this action results in a single source file modification -// containing all the generated method stubs. -// -// Example: -// -// class Base { -// public: -// virtual void publicMethod() = 0; -// protected: -// virtual auto privateMethod() const -> int = 0; -// }; -// -// Before: -// // cursor here -// class Derived : public Base {}^; -// -// After: -// -// class Derived : public Base { -// public: -// void publicMethod() override { -// // TODO: Implement this pure virtual method. -// static_assert(false, "Method `publicMethod` is not implemented."); -// } -// -// protected: -// auto privateMethod() const -> int override { -// // TODO: Implement this pure virtual method. -// static_assert(false, "Method `privateMethod` is not implemented."); -// } -// }; -// -//===----------------------------------------------------------------------===// - -#include "refactor/Tweak.h" -#include "support/Token.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 <string> - -namespace clang { -namespace clangd { -namespace { - -// This function removes the "virtual" and the "= 0" at the end; -// e.g.: -// "virtual void foo(int var = 0) = 0" // input. -// "void foo(int var = 0)" // output. -std::string removePureVirtualSyntax(const std::string &MethodDecl, - const LangOptions &LangOpts) { - assert(!MethodDecl.empty()); - - TokenStream TS = lex(MethodDecl, LangOpts); - - std::string DeclString; - for (const clangd::Token &Tk : TS.tokens()) { - if (Tk.Kind == clang::tok::raw_identifier && Tk.text() == "virtual") - continue; - - // If the ending two tokens are "= 0", we break here and we already have the - // method's string without the pure virtual syntax. - const auto &Next = Tk.next(); - if (Next.next().Kind == tok::eof && Tk.Kind == clang::tok::equal && - Next.text() == "0") - break; - - DeclString += Tk.text(); - if (Tk.Kind != tok::l_paren && Next.Kind != tok::comma && - Next.Kind != tok::r_paren && Next.Kind != tok::l_paren) - DeclString += ' '; - } - // Trim the last whitespace. - if (DeclString.back() == ' ') - DeclString.pop_back(); - - return DeclString; -} - -class OverridePureVirtuals final : 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::QUICKFIX_KIND; - } - -private: - // Stores the CXXRecordDecl of the class being modified. - const CXXRecordDecl *CurrentDeclDef = nullptr; - // Stores pure virtual methods that need overriding, grouped by their original - // access specifier. - llvm::MapVector<AccessSpecifier, llvm::SmallVector<const CXXMethodDecl *>> - MissingMethodsByAccess; - // Stores the source locations of existing access specifiers in CurrentDecl. - llvm::MapVector<AccessSpecifier, SourceLocation> AccessSpecifierLocations; - // Helper function to gather information before applying the tweak. - void collectMissingPureVirtuals(); -}; - -REGISTER_TWEAK(OverridePureVirtuals) - -// Function to get all unique pure virtual methods from the entire -// base class hierarchy of CurrentDeclDef. -llvm::SmallVector<const clang::CXXMethodDecl *> -getAllUniquePureVirtualsFromBaseHierarchy( - const clang::CXXRecordDecl *CurrentDeclDef) { - llvm::SmallVector<const clang::CXXMethodDecl *> AllPureVirtualsInHierarchy; - llvm::DenseSet<const clang::CXXMethodDecl *> CanonicalPureVirtualsSeen; - - if (!CurrentDeclDef || !CurrentDeclDef->getDefinition()) - return AllPureVirtualsInHierarchy; - - const clang::CXXRecordDecl *Def = CurrentDeclDef->getDefinition(); - - Def->forallBases([&](const clang::CXXRecordDecl *BaseDefinition) { - for (const clang::CXXMethodDecl *Method : BaseDefinition->methods()) { - if (Method->isPureVirtual() && - CanonicalPureVirtualsSeen.insert(Method->getCanonicalDecl()).second) - AllPureVirtualsInHierarchy.emplace_back(Method); - } - // Continue iterating through all bases. - return true; - }); - - return AllPureVirtualsInHierarchy; -} - -// Gets canonical declarations of methods already overridden or implemented in -// class D. -llvm::SetVector<const CXXMethodDecl *> -getImplementedOrOverriddenCanonicals(const CXXRecordDecl *D) { - llvm::SetVector<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`. -llvm::MapVector<AccessSpecifier, SourceLocation> -getSpecifierLocations(const CXXRecordDecl *D) { - llvm::MapVector<AccessSpecifier, SourceLocation> Locs; - for (auto *DeclNode : D->decls()) { - if (const auto *ASD = llvm::dyn_cast<AccessSpecDecl>(DeclNode)) - Locs[ASD->getAccess()] = ASD->getColonLoc(); - } - return Locs; -} - -bool hasAbstractBaseAncestor(const clang::CXXRecordDecl *CurrentDecl) { - assert(CurrentDecl && CurrentDecl->getDefinition()); - - return llvm::any_of( - CurrentDecl->getDefinition()->bases(), [](CXXBaseSpecifier BaseSpec) { - const auto *D = BaseSpec.getType()->getAsCXXRecordDecl(); - const auto *Def = D ? D->getDefinition() : nullptr; - return Def && Def->isAbstract(); - }); -} - -// The tweak is available if the selection is over an abstract C++ class -// definition that also inherits from at least one other abstract class. -bool OverridePureVirtuals::prepare(const Selection &Sel) { - const SelectionTree::Node *Node = Sel.ASTSelection.commonAncestor(); - if (!Node) - return false; - - // Make sure we have a definition. - CurrentDeclDef = Node->ASTNode.get<CXXRecordDecl>(); - if (!CurrentDeclDef || !CurrentDeclDef->getDefinition()) - return false; - - // From now on, we should work with the definition. - CurrentDeclDef = CurrentDeclDef->getDefinition(); - - // Only offer for abstract classes with abstract bases. - return CurrentDeclDef->isAbstract() && - hasAbstractBaseAncestor(CurrentDeclDef); -} - -// Collects all pure virtual methods from base classes that `CurrentDeclDef` has -// not yet overridden, grouped by their original access specifier. -// -// Results are stored in `MissingMethodsByAccess` and `AccessSpecifierLocations` -// is also populated. -void OverridePureVirtuals::collectMissingPureVirtuals() { - if (!CurrentDeclDef) - return; - - AccessSpecifierLocations = getSpecifierLocations(CurrentDeclDef); - MissingMethodsByAccess.clear(); - - // Get all unique pure virtual methods from the entire base class hierarchy. - llvm::SmallVector<const CXXMethodDecl *> AllPureVirtualsInHierarchy = - getAllUniquePureVirtualsFromBaseHierarchy(CurrentDeclDef); - - // Get methods already implemented or overridden in CurrentDecl. - const auto ImplementedOrOverriddenSet = - getImplementedOrOverriddenCanonicals(CurrentDeclDef); - - // Filter AllPureVirtualsInHierarchy to find those not in - // ImplementedOrOverriddenSet, which needs to be overriden. - for (const CXXMethodDecl *BaseMethod : AllPureVirtualsInHierarchy) { - bool AlreadyHandled = ImplementedOrOverriddenSet.contains(BaseMethod); - if (!AlreadyHandled) - MissingMethodsByAccess[BaseMethod->getAccess()].emplace_back(BaseMethod); - } -} - -std::string generateOverrideString(const CXXMethodDecl *Method, - const LangOptions &LangOpts) { - std::string MethodDecl; - auto OS = llvm::raw_string_ostream(MethodDecl); - Method->print(OS); - - return llvm::formatv( - "\n {0} override {{\n" - " // TODO: Implement this pure virtual method.\n" - " static_assert(false, \"Method `{1}` is not implemented.\");\n" - " }", - removePureVirtualSyntax(MethodDecl, LangOpts), Method->getName()) - .str(); -} - -// Free function to generate the string for a group of method overrides. -std::string generateOverridesStringForGroup( - llvm::SmallVector<const CXXMethodDecl *> Methods, - const LangOptions &LangOpts) { - llvm::SmallVector<std::string> MethodsString; - MethodsString.reserve(Methods.size()); - - for (const CXXMethodDecl *Method : Methods) { - MethodsString.emplace_back(generateOverrideString(Method, LangOpts)); - } - - return llvm::join(MethodsString, "\n") + '\n'; -} - -Expected<Tweak::Effect> OverridePureVirtuals::apply(const Selection &Sel) { - // The correctness of this tweak heavily relies on the accurate population of - // these members. - collectMissingPureVirtuals(); - // The `prepare` should prevent this. If the prepare identifies an abstract - // method, then is must have missing methods. - assert(!MissingMethodsByAccess.empty()); - - 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; - - for (const auto &[AS, Methods] : MissingMethodsByAccess) { - assert(!Methods.empty()); - - std::string MethodsGroupString = - generateOverridesStringForGroup(Methods, LangOpts); - - auto *ExistingSpecLocIter = AccessSpecifierLocations.find(AS); - bool ASExists = ExistingSpecLocIter != AccessSpecifierLocations.end(); - if (ASExists) { - // 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 = MethodsGroupString; - tooling::Replacement Rep(SM, InsertLoc, 0, InsertionText); - if (auto Err = EditReplacements.add(Rep)) - 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. - NewSectionsToAppendText += - getAccessSpelling(AS).str() + ':' + MethodsGroupString; - } - } - - // 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 = CurrentDeclDef->getBraceRange().getEnd(); - std::string FinalAppendText = std::move(NewSectionsToAppendText); - - if (!CurrentDeclDef->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)) - 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 d425070c7f3b7..dffdcd5d014ca 100644 --- a/clang-tools-extra/clangd/unittests/CMakeLists.txt +++ b/clang-tools-extra/clangd/unittests/CMakeLists.txt @@ -131,7 +131,6 @@ 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 deleted file mode 100644 index b7dcbee1650ec..0000000000000 --- a/clang-tools-extra/clangd/unittests/tweaks/OverridePureVirtualsTests.cpp +++ /dev/null @@ -1,720 +0,0 @@ -//===-- OverridePureVirtualsTests.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 OverridePureVirtualsTests : public TweakTest { -protected: - OverridePureVirtualsTests() : TweakTest("OverridePureVirtuals") {} -}; - -TEST_F(OverridePureVirtualsTests, MinimalUnavailable) { - EXPECT_UNAVAILABLE("class ^C {};"); -} - -TEST_F(OverridePureVirtualsTests, MinimalAvailable) { - EXPECT_AVAILABLE(R"cpp( -class B { public: virtual void Foo() = 0; }; -class ^C : public B {}; -)cpp"); -} - -TEST_F(OverridePureVirtualsTests, UnavailableWhenOverriden) { - EXPECT_UNAVAILABLE( - R"cpp( -class B { -public: - virtual void foo() = 0; -}; - -class ^D : public B { -public: - void foo() override; -}; -)cpp"); -} - -TEST_F(OverridePureVirtualsTests, AvailabilityNoOverride) { - EXPECT_AVAILABLE(R"cpp( -class Base { -public: -virtual ~Base() = default; -virtual void F1() = 0; -virtual void F2() = 0; -}; - -class ^Derived : public Base { -public: -}; - -)cpp"); -} - -TEST_F(OverridePureVirtualsTests, AvailabilityPartiallyOverridden) { - 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(OverridePureVirtualsTests, 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(OverridePureVirtualsTests, 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(OverridePureVirtualsTests, 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(OverridePureVirtualsTests, 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(OverridePureVirtualsTests, 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 : public Left, public Right {}; -)cpp"; - const auto *Expected = 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 : public Left, public Right { -public: - void diamond_func() override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `diamond_func` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, MixedAccessSpecifiers) { - const char *Before = R"cpp( -class Base { -public: - virtual void pub_func() = 0; - virtual void pub_func2(char) const = 0; -protected: - virtual int prot_func(int x) const = 0; -}; - -class ^Derived : public Base { - int member; // Existing member -public: - Derived(int m) : member(m) {} -}; -)cpp"; - const auto *Expected = R"cpp( -class Base { -public: - virtual void pub_func() = 0; - virtual void pub_func2(char) const = 0; -protected: - virtual int prot_func(int x) const = 0; -}; - -class Derived : public Base { - int member; // Existing member -public: - void pub_func() override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `pub_func` is not implemented."); - } - - void pub_func2(char) const override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `pub_func2` is not implemented."); - } - - Derived(int m) : member(m) {} - -protected: - int prot_func(int x) const override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `prot_func` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, OutOfOrderMixedAccessSpecifiers) { - const char *Before = R"cpp( -class Base { -public: - virtual void pub_func() = 0; - virtual void pub_func2(char) const = 0; -protected: - virtual int prot_func(int x) const = 0; -}; - -class ^Derived : public Base { - int member; // Existing member -protected: - void foo(); -public: - Derived(int m) : member(m) {} -}; -)cpp"; - const auto *Expected = R"cpp( -class Base { -public: - virtual void pub_func() = 0; - virtual void pub_func2(char) const = 0; -protected: - virtual int prot_func(int x) const = 0; -}; - -class Derived : public Base { - int member; // Existing member -protected: - int prot_func(int x) const override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `prot_func` is not implemented."); - } - - void foo(); -public: - void pub_func() override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `pub_func` is not implemented."); - } - - void pub_func2(char) const override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `pub_func2` is not implemented."); - } - - Derived(int m) : member(m) {} -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, MultiAccessSpecifiersOverride) { - constexpr auto Before = R"cpp( -class Base { -public: - virtual void foo() = 0; -protected: - virtual void bar() = 0; -}; - -class ^Derived : public Base {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class Base { -public: - virtual void foo() = 0; -protected: - virtual void bar() = 0; -}; - -class Derived : public Base { -public: - void foo() override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `foo` is not implemented."); - } -protected: - void bar() override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `bar` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, AccessSpecifierAlreadyExisting) { - const char *Before = R"cpp( -class Base { -public: - virtual void func1() = 0; -}; - -class ^Derived : public Base { -public: -}; -)cpp"; - - const auto *Expected = R"cpp( -class Base { -public: - virtual void func1() = 0; -}; - -class Derived : public Base { -public: - void func1() override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `func1` is not implemented."); - } - -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, ConstexprSpecifier) { - ExtraArgs.push_back("-std=c++20"); - - constexpr auto Before = R"cpp( -class B { -public: - constexpr virtual int getValue() const = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - constexpr virtual int getValue() const = 0; -}; - -class D : public B { -public: - constexpr int getValue() const override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `getValue` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, ConstevalSpecifier) { - ExtraArgs.push_back("-std=c++20"); - - constexpr auto Before = R"cpp( -class B { -public: - virtual consteval float calculate() = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - virtual consteval float calculate() = 0; -}; - -class D : public B { -public: - consteval float calculate() override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `calculate` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, LValueRefQualifier) { - constexpr auto Before = R"cpp( -class B { -public: - virtual void process() & = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - virtual void process() & = 0; -}; - -class D : public B { -public: - void process() & override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `process` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, RValueRefQualifier) { - constexpr auto Before = R"cpp( -class B { -public: - virtual bool isValid() && = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - virtual bool isValid() && = 0; -}; - -class D : public B { -public: - bool isValid() && override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `isValid` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, SimpleTrailingReturnType) { - constexpr auto Before = R"cpp( -class B { -public: - virtual auto getStatus() -> bool = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - virtual auto getStatus() -> bool = 0; -}; - -class D : public B { -public: - auto getStatus() -> bool override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `getStatus` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, ConstexprLValueRefAndTrailingReturn) { - ExtraArgs.push_back("-std=c++20"); - - constexpr auto Before = R"cpp( -class B { -public: - constexpr virtual auto getData() & -> const char * = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - constexpr virtual auto getData() & -> const char * = 0; -}; - -class D : public B { -public: - constexpr auto getData() & -> const char * override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `getData` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, ConstevalRValueRefAndTrailingReturn) { - ExtraArgs.push_back("-std=c++20"); - - constexpr auto Before = R"cpp( -class B { -public: - virtual consteval auto foo() && -> double = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - virtual consteval auto foo() && -> double = 0; -}; - -class D : public B { -public: - consteval auto foo() && -> double override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `foo` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, CombinedFeaturesWithTrailingReturnTypes) { - ExtraArgs.push_back("-std=c++20"); - - constexpr auto Before = R"cpp( -class B { -public: - virtual auto f1() & -> int = 0; - constexpr virtual auto f2() && -> int = 0; - virtual consteval auto f3() -> int = 0; - virtual auto f4() const & -> char = 0; - constexpr virtual auto f5() const && -> bool = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - virtual auto f1() & -> int = 0; - constexpr virtual auto f2() && -> int = 0; - virtual consteval auto f3() -> int = 0; - virtual auto f4() const & -> char = 0; - constexpr virtual auto f5() const && -> bool = 0; -}; - -class D : public B { -public: - auto f1() & -> int override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `f1` is not implemented."); - } - - constexpr auto f2() && -> int override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `f2` is not implemented."); - } - - consteval auto f3() -> int override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `f3` is not implemented."); - } - - auto f4() const & -> char override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `f4` is not implemented."); - } - - constexpr auto f5() const && -> bool override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `f5` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -TEST_F(OverridePureVirtualsTests, DefaultParameters) { - ExtraArgs.push_back("-std=c++20"); - - constexpr auto Before = R"cpp( -class B { -public: - virtual void foo(int var = 0) = 0; -}; - -class ^D : public B {}; -)cpp"; - - constexpr auto Expected = R"cpp( -class B { -public: - virtual void foo(int var = 0) = 0; -}; - -class D : public B { -public: - void foo(int var = 0) override { - // TODO: Implement this pure virtual method. - static_assert(false, "Method `foo` is not implemented."); - } -}; -)cpp"; - auto Applied = apply(Before); - EXPECT_EQ(Expected, Applied) << "Applied result:\n" << Applied; -} - -} // namespace -} // namespace clangd -} // namespace clang diff --git a/clang-tools-extra/docs/ReleaseNotes.rst b/clang-tools-extra/docs/ReleaseNotes.rst index c75d9ca71cad7..eafbdecd406b2 100644 --- a/clang-tools-extra/docs/ReleaseNotes.rst +++ b/clang-tools-extra/docs/ReleaseNotes.rst @@ -67,14 +67,6 @@ Code completion Code actions ^^^^^^^^^^^^ -- New ``Override pure virtual methods`` code action. When invoked on a class - definition, this action automatically generates C++ ``override`` declarations - for all pure virtual methods inherited from its base classes that have not yet - been implemented. The generated method stubs prompts the user for the actual - implementation. The overrides are intelligently grouped under their original - access specifiers (e.g., ``public``, ``protected``), creating new access - specifier blocks if necessary. - Signature help ^^^^^^^^^^^^^^ _______________________________________________ llvm-branch-commits mailing list llvm-branch-commits@lists.llvm.org https://lists.llvm.org/cgi-bin/mailman/listinfo/llvm-branch-commits
