c++ - 在堆栈上分配不完整类型

Question

我正在研究用 C 语言包装 C++ 库。C++ 库是数据库服务器的库。它使用包装类来传递序列化数据。我无法直接在 C 中使用该类，因此我定义了一个可以在 C 代码中使用的结构，如下所示:

在 include/c-wrapper/c-wrapper.h 中(这是我的 C 包装器的客户端包含的包装器)

extern "C" {
    typedef struct Hazelcast_Data_t Hazelcast_Data_t;

    Hazelcast_Data_t *stringToData(char *str);
    void freeData(Hazelcast_Data_t *d);
}

在 impl.pp

extern "C" struct Hazelcast_Data_t {
    hazelcast::client::serialization::pimpl::Data data; // this is the C++ class
};

Hazelcast_Data_t *stringToData(char *str) {
     Data d = serializer.serialize(str);

     Hazelcast_Data_t *dataStruct = new Hazelcast_Data_t();
     dataStruct->data = d;

     return dataStruct;
}

...

现在可以了，我的 C 库的客户端只能看到 typedef struct Hazelcast_Data_t Hazelcast_Data_t;。问题是，上述类型无法在堆栈上分配，就像我想提供这样的 API 一样:

// this is what I want to achieve, but Hazelcast_Data_t is an incomplete type
#include <include/c-wrapper/c-wrapper.h>

int main() {
    char *str = "BLA";
    Hazelcast_Data_t d;
    stringToData(str, &d);
}

编译器将抛出 Hazelcast_Data_t 是不完整类型的错误。我仍然想提供一个 API，允许将 Hazelcast_Data_t 的堆栈分配引用传递给序列化函数，但因为 Hazelcast_Data_t 有一个指向 C++ 类的指针，所以这个似乎几乎不可能。然而，拥有传递堆栈分配引用的选项将大大简化我的 C 库客户端的代码(无需释放新结构)。

是否可以以某种方式重新定义Hazelcast_Data_t类型，以便它可以在C中使用并且仍然可以在堆栈上分配？

Answer 1

您考虑执行此操作的大多数 hack 都会调用未定义的行为，因为在创建结构时 C 不会为所包含的对象调用 C++ 构造函数，并且在结构超出范围时不会调用 C++ 析构函数。为了使其工作，您需要结构体包含正确大小的缓冲区，并在 init 函数中将其 new 到该缓冲区中，并在完成后调用该缓冲区的析构函数。这意味着代码看起来像这样(假设没有任何异常 - 在这种情况下您需要添加异常处理和翻译...)

struct wrapper {
  char buffer[SIZE_OF_CXX_CLASS];
}

void wrapper_init() {
   new (buffer) Wrapped();
}

void wrapper_destroy() {
   ((Wrapper*)buffer)->~Wrapper();
}

{
  struct wrapper wrapped;
  wrapper_init(&wrapped);
  // ... use it ...
  wrapper_destroy(&wrapped);
}

如果您忘记调用wrapper_init，所有内容都会进入未定义的行为区域。如果你忘记调用 wrapper_destroy 我想你也会得到 UB。

但是，由于这会迫使调用者调用 init 和 destroy 函数，因此与使用指针相比几乎没有什么好处。我什至声称使用结构体而不是指针向 API 用户表明初始化应该是微不足道的，并且销毁是不必要的。 IE。作为 API 用户，我希望能够做到

 {
   struct wrapper wrapped = WRAPPER_INIT; //Trivial initialisaton macro
   // .. use it ..
   // No need to do anything it is a trivial object.
 }

在不可能的情况下(比如你的情况)，我会坚持使用通常的在堆上分配习惯用法

{
   struct wrapper* wrapped = wrapper_create();
   // ... use it ...
   wrapper_destroy(wrapped);
}