C ++:覆盖已弃用的虚拟方法时的弃用警告

时间:2018-02-27 15:12:00

标签: c++ inheritance const virtual deprecation-warning

我有一个纯虚拟类,它有一个纯虚方法,应该是const,但遗憾的是不是。此接口位于库中,并且该类在单独的项目中由其他几个类继承。

我正在尝试在不破坏兼容性的情况下创建此方法const(至少在一段时间内),但是当非const方法重载时,我找不到生成警告的方法。

以下是我迄今为止能够制作的一个例子:

  • 第0阶段:更改前。只存在非{const}版本的Interface::doSomething()方法,它是纯虚拟的。
  • 第1阶段:在过渡期间。存在Interface::doSomething()方法的const和非const版本。它们都有一个默认实现,以便允许旧样式和新样式实现(在这个阶段它们不能是纯虚拟的,因为每个继承的类只会覆盖其中一个)。 const版本调用非const版本以确保与旧实现的兼容性,非const版本断言,因为它永远不应该被调用。
  • 第2阶段:只存在非{const}版本的Interface::doSomething()方法且它是纯虚拟的。

第1阶段中,我希望能够在类重写Interface::doSomething()的非常量版本时生成警告,以警告用户他们应该更新他们的代码,这样当我切换到阶段2 时,打破其他人的代码的机会非常低。 不幸的是我找不到办法做到这一点。我尝试了几种旗帜组合,包括GCC和Clang。我唯一能做的就是让编译失败(例如将其更改为final),但这不是我想要处理的方式。有没有办法产生警告?

#include <iostream>
#include <cassert>

class Interface
{
public:
    virtual ~Interface() = default;

// callDoSomething method:
// - stage 0: non const
// - stage 1-2: const
#if (STAGE == 0)
    void callDoSomething() { doSomething(); }
#else
    void callDoSomething() const { doSomething(); }
#endif

protected:

// non-const doSomething() method:
// - stage 0: pure virtual
// - stage 1: virtual with assert in default implementation (should never be called)
// - stage 2: removed
#if (STAGE == 0)
    virtual void doSomething() = 0;
#elif (STAGE == 1)
    [[deprecated("Overload const version instead")]]
    virtual void doSomething()
    {
        assert(false);
    }
#endif

// const doSomething() method
// - stage 0: N/A
// - stage 1: virtual with default implementation (calls the non-const overload)
// - stage 2: pure virtual
#if (STAGE == 1)
    virtual void doSomething() const
    {
        std::cout << __PRETTY_FUNCTION__ << '\n';
        std::cout << "  calling non const version\n";
#pragma GCC diagnostic push
#pragma GCC diagnostic ignored "-Wdeprecated-declarations"
        const_cast<Interface*>(this)->doSomething();
#pragma GCC diagnostic pop
    }
#elif (STAGE == 2)
    virtual void doSomething() const = 0;
#endif
};


// Old style implementation: non-const doSomething()
// Allowed only in stages 0 and 1
#if (STAGE == 0 || STAGE == 1)
class Implementation_old : public Interface
{
public:
    virtual ~Implementation_old() = default;

protected:
    virtual void doSomething() override
    {
        std::cout << __PRETTY_FUNCTION__ << '\n';
    }
};
# endif


// Old style implementation: const doSomething()
// Allowed only in stages 1 and 2
#if (STAGE == 1 || STAGE == 2)
class Implementation_new : public Interface
{
public:
    virtual ~Implementation_new() = default;

protected:
    virtual void doSomething() const override
    {
        std::cout << __PRETTY_FUNCTION__ << '\n';
    }
};
#endif


int main(int argc, char *argv[])
{
    Interface* iface = nullptr;

#if (STAGE == 0 || STAGE == 1)
    iface = new Implementation_old;
    iface->callDoSomething();
    delete iface;
#endif

#if (STAGE == 1)
    std::cout << "-------------------\n";
#endif

#if (STAGE == 1 || STAGE == 2)
    iface = new Implementation_new;
    iface->callDoSomething();
    delete iface;
#endif

    iface = nullptr;

    return 0;
}

这是使用STAGE

的3个定义构建示例的CMakeLists.txt文件
cmake_minimum_required(VERSION 3.5)
project(test_deprecate_non_const)

set(CMAKE_CXX_STANDARD 14)
set(CMAKE_CXX_STANDARD_REQUIRED ON)
set(CMAKE_CXX_EXTENSIONS OFF)

add_executable(main_stage_0 main.cpp)
target_compile_definitions(main_stage_0 PRIVATE STAGE=0)

add_executable(main_stage_1 main.cpp)
target_compile_definitions(main_stage_1 PRIVATE STAGE=1)

add_executable(main_stage_2 main.cpp)
target_compile_definitions(main_stage_2 PRIVATE STAGE=2)

1 个答案:

答案 0 :(得分:3)

对使用不推荐使用的界面发出警告会很好。然而,我的尝试失败了,因为你的尝试。我认为不幸的是,属性并没有考虑到这一点。我认为属性适用于实体的名称,这意味着只有在按名称调用方法时才会收到警告。但我没有研究这方面的标准。

所以,心里悲伤,我会从this answer偷一个温和相关的帖子:

  

告诉您的用户该功能已弃用且不应使用,然后继续。