如何确保使用相同的宏的不同C++代码库?

How to make sure different C++ code base using the same macro?

本文关键字：代码 C++ 何确保 确保      更新时间：2023-10-16

我们正在研究两个C++代码库，我们称之为A和B，A是一个构建库，并将头文件.h和.a文件分发给B。

假设A中有Lock.h文件，如下所示：

// Lock.h in code base A
class Lock {
... ...
#ifdef TRACK_THREAD_OWNER_FOR_DEBUG
virtual int GetLockOwner();
#endif
... ...
private:
CriticalSection section;
#ifdef TRACK_THREAD_OWNER_FOR_DEBUG
int threadOwner;
#endif
};
// Caller.cc in code base B
#include "xxx/xxx/Lock.h"
Lock lockObject;
lockObject.Lock();

在代码库A中，默认情况下，我们将启用TRACK_THREAD_OWNER_FOR_DEBUG，并可能在最终发布日之前对其进行更改。

我们遇到了一些硬错误，因为A和B中的TRACK_THREAD_OWNER_FOR_DEBUG不同，并且由于两个库中的sizeof(Lock)不同而导致内存损坏。

那么如何防止此错误呢？如果两个项目中的构建宏TRACK_THREAD_OWNER_FOR_DEBUG不同，我们可以在构建caller.cc文件时触发编译器错误吗？

不可能将其变成编译器错误，但是应该可以通过导出一些名称取决于当前定义的宏的符号来将其变成相当清晰的链接器错误。例如使用静态保护变量：

//  Foo.hpp - library header file
#pragma once
class Foo
{
public: Foo();
#ifdef IMPORTANT_CONDITION
int m_field;
#endif
};
class ConditionGuard
{
public:
ConditionGuard(void) noexcept
{
#ifdef IMPORTANT_CONDITION
CONDITION_ON();
#else
CONDITION_OFF();
#endif
}
#ifdef IMPORTANT_CONDITION
private: static void CONDITION_ON(void);
#else
private: static void CONDITION_OFF(void);
#endif
};
static ConditionGuard const condition_guard{};
// Foo.cpp - library implementation file 
#include "Foo.hpp"
Foo::Foo(void) {}
#ifdef IMPORTANT_CONDITION
void ConditionGuard::CONDITION_ON(void) {}
#else
void ConditionGuard::CONDITION_OFF(void) {}
#endif

现在，当用户代码包含库标头Foo.hpp它还将触发condition_guard静态变量的构造，该静态变量将根据受保护的条件调用库函数。因此，如果有一个翻译单元包含Foo.hpp其中IMPORTANT_CONDITION的定义与编译库中的定义不同，那么将出现缺少CONDITION_ON或CONDITION_OFF的链接器错误。CONDITION_ON和CONDITION_OFF函数名称应包含错误文本。

一种选择是将 A 的完整代码包含在项目 B 中。通过将 A 编译到静态库中，您想做什么？

我认为您最好的选择是根据目标生成不同的.a文件，即设置TRACK_THREAD_OWNER_FOR_DEBUG时为libA_debug.a，未设置时为libA.a。

然后，您可以根据您正在编译调试版本还是发布版本来设置要将 B 链接到的库。

相关文章：