C++标记为已弃用

Question

我在接口中有一个方法,我想用便携式C++弃用.当我用Google搜索时,我得到的只是Microsoft特定的解决方案; #pragma deprecated和__declspec(不建议使用).

二等奖解决方案是ifdef MSVC和GCC解决方案.
谢谢

Answer 1

在C++ 14中,您可以使用该[[deprecated]]属性将函数标记为已弃用(请参见第7.6.5节[dcl.attr.deprecated]).

该属性令牌 deprecated可以用来标记的名称和它的使用仍然是允许的实体,但不鼓励出于某种原因.

例如,foo不推荐使用以下函数:

[[deprecated]]
void foo(int);

可以提供描述不推荐使用名称或实体的原因的消息:

[[deprecated("Replaced by bar, which has an improved interface")]]
void foo(int);

消息必须是字符串文字.

有关更多详细信息,请参阅"在C++ 14中标记为已弃用".

Answer 2

这应该做的伎俩:

#ifdef __GNUC__
#define DEPRECATED(func) func __attribute__ ((deprecated))
#elif defined(_MSC_VER)
#define DEPRECATED(func) __declspec(deprecated) func
#else
#pragma message("WARNING: You need to implement DEPRECATED for this compiler")
#define DEPRECATED(func) func
#endif

...

//don't use me any more
DEPRECATED(void OldFunc(int a, float b));

//use me instead
void NewFunc(int a, double b);

但是,如果函数返回类型的名称中包含逗号,则会遇到问题,例如std::pair<int, int>,这将由preprocesor解释为将2个参数传递给DEPRECATED宏.在这种情况下,您必须键入dede返回类型.

编辑:此处更简单(但可能不太广泛兼容)版本.

Answer 3

这是我2008年答案的简化版本:

#if defined(__GNUC__) || defined(__clang__)
#define DEPRECATED __attribute__((deprecated))
#elif defined(_MSC_VER)
#define DEPRECATED __declspec(deprecated)
#else
#pragma message("WARNING: You need to implement DEPRECATED for this compiler")
#define DEPRECATED
#endif

//...

//don't use me any more
DEPRECATED void OldFunc(int a, float b);

//use me instead
void NewFunc(int a, double b);

也可以看看:

• MSVC文档 __declspec(deprecated)
• GCC文档 __attribute__((deprecated))
• Clang文档 __attribute__((deprecated))

Answer 4

在GCC中,您可以使用不推荐使用的属性声明您的函数,如下所示:

void myfunc() __attribute__ ((deprecated));

当在.c文件中使用该函数时,这将触发编译时警告.

您可以在http://gcc.gnu.org/onlinedocs/gcc/Pragmas.html上的 "Diagnostic pragmas"下找到更多信息.

Answer 5

这是2018年的更完整答案。

如今，许多工具不仅使您可以将某项标记为已弃用，还可以提供消息。这使您可以告诉人们何时不推荐使用某些产品，甚至可以将其指向替代产品。

编译器支持仍然有很多种类：

• C ++ 14支持[[deprecated]]/ [[deprecated(message)]]。
• __attribute__((deprecated)) 由GCC 4.0+和ARM 4.1+支持
• __attribute__((deprecated))并__attribute__((deprecated(message)))支持：
  • 海湾合作委员会4.5+
  • 几个伪装成GCC 4.5+的编译器（通过设置__GNUC__/ __GNUC_MINOR__/ __GNUC_PATCHLEVEL__）
  • 英特尔C / C ++编译器至少可以恢复到16（您不信任__GNUC__/ __GNUC_MINOR__，他们只是将其设置为已安装的GCC的任何版本）
  • ARM 5.6以上
• __declspec(deprecated)从13.10开始支持MSVC （Visual Studio 2003）
• __declspec(deprecated(message))从14.0开始支持MSVC （Visual Studio 2005）

您还可以[[gnu::deprecated]]基于，在C ++ 11的最新版本的clang中使用__has_cpp_attribute(gnu::deprecated)。

我在Hedley中有一些宏可以自动处理所有这些宏，这些宏我一直保持最新，但是当前版本（v2）如下所示：

#if defined(__cplusplus) && (__cplusplus >= 201402L)
#  define HEDLEY_DEPRECATED(since) [[deprecated("Since " #since)]]
#  define HEDLEY_DEPRECATED_FOR(since, replacement) [[deprecated("Since " #since "; use " #replacement)]]
#elif \
  HEDLEY_GCC_HAS_EXTENSION(attribute_deprecated_with_message,4,5,0) || \
  HEDLEY_INTEL_VERSION_CHECK(16,0,0) || \
  HEDLEY_ARM_VERSION_CHECK(5,6,0)
#  define HEDLEY_DEPRECATED(since) __attribute__((__deprecated__("Since " #since)))
#  define HEDLEY_DEPRECATED_FOR(since, replacement) __attribute__((__deprecated__("Since " #since "; use " #replacement)))
#elif \
  HEDLEY_GCC_HAS_ATTRIBUTE(deprcated,4,0,0) || \
  HEDLEY_ARM_VERSION_CHECK(4,1,0)
#  define HEDLEY_DEPRECATED(since) __attribute__((__deprecated__))
#  define HEDLEY_DEPRECATED_FOR(since, replacement) __attribute__((__deprecated__))
#elif HEDLEY_MSVC_VERSION_CHECK(14,0,0)
#  define HEDLEY_DEPRECATED(since) __declspec(deprecated("Since " # since))
#  define HEDLEY_DEPRECATED_FOR(since, replacement) __declspec(deprecated("Since " #since "; use " #replacement))
#elif HEDLEY_MSVC_VERSION_CHECK(13,10,0)
#  define HEDLEY_DEPRECATED(since) _declspec(deprecated)
#  define HEDLEY_DEPRECATED_FOR(since, replacement) __declspec(deprecated)
#else
#  define HEDLEY_DEPRECATED(since)
#  define HEDLEY_DEPRECATED_FOR(since, replacement)
#endif

我将把它作为练习，以弄清楚如果您不想使用Hedley的话，该如何摆脱*_VERSION_CHECKand *_HAS_ATTRIBUTE宏（我写Hedley的主要目的是因为我不必定期考虑这一点）。

如果使用GLib，则可以使用G_DEPRECATED和G_DEPRECATED_FOR宏。它们的功能不如Hedley的功能强大，但是如果您已经使用GLib，则无需添加任何内容。