避免泄漏 C++ 中的外部类型班级

Question

我在标头中定义了一个类，如下所示（缩写）：

class CairoRenderer
{
public:
    CairoRenderer();
    ~CairoRenderer();
...
protected:
    cairo_t* m_context;
    cairo_surface_t* m_surface;
};

cairo_t 和 cairo_surface_t 是由 Cairo 图形库定义的类型。

我遇到的问题是，如果我想使用此类或其来自另一个库或应用程序的派生类，我还需要包含 cairo 标头，因为我通过 CairoRenderer 标头“泄漏”了 cairo 类型。我希望同一库中的此类（或其任何子类）可以在外部使用，而无需包含 cairo 标头或针对 cairo 库的链接。

所以我尝试的下一件事是按照 Wikipedia 示例使用 pimpl 技术，因为它看起来像它可以实现我想要实现的目标：

CairoRenderer.h （缩写）

class CairoRenderer
{
...
protected:
    struct CairoRendererImpl;
    CairoRendererImpl* m_pimpl;
};

CairoRenderer.cpp （缩写）

#include "CairoRenderer.h"
#include "cairo.h"

....

struct CairoRenderer::CairoRendererImpl 
{
public:
    CairoRendererImpl() : m_surface(NULL), m_context(NULL) { }
    ~CairoRendererImpl() 
    {
        cairo_surface_destroy(m_surface);
        cairo_destroy(m_context);
    }

    void Initialize(cairo_t* context, cairo_surface_t* surface)
    {
        m_context = context;
        m_surface = surface;
    }

    cairo_surface_t* surface() { return m_surface; }
    cairo_t* context() { return m_context; }

private:
    cairo_surface_t* m_surface;
    cairo_t* m_context;
};

CairoRenderer::CairoRenderer() : m_pimpl(new CairoRendererImpl()) { ... }

CairoRenderer::~CairoRenderer() { delete m_pimpl; }

我遇到的问题是当我尝试从派生类访问 m_pimpl 成员时，我得到了编译器错误：

error C2027: use of undefined type 'CairoRenderer::CairoRendererImpl'

我做的pimpl错了吗？或者我想做的事情是否可能？

Answer 1

您正确使用了 pimpl 习惯用法，这就是您的问题。您已对所有外部代码（包括派生类中的代码）隐藏了CairoRendererImpl 的定义。

首先，我想质疑具有数据成员和非虚拟析构函数的基类的价值。您应该查看想要子类化 CairoRenderer 的根本原因，并考虑替代解决方案。

如果您确实想要支持子类化，但仅限于库中的类，那么您应该将CairoRendererImpl的定义放入一个共享头文件中，该文件可以由CairoRenderer heirachy 中所有相关类的实现文件。

Answer 2

pimpl 惯用语用得还可以。

避免必须包含 cairo.h 文件的方法是在 CairoRenderer.h 文件中包含以下声明（即 前向声明）

class CairoRendererImpl;

，然后就这样；不要包含 CairoRendererImpl.h，因为这需要拖入 cairo.h 的定义。

您可以这样做，因为 CairoRenderer 只需要一个指向实现的指针 - 只要您实际上不调用头文件中的任何方法（例如内联函数），编译器就不需要查看完整的声明CairoRendererImpl 类的。

在 CairoRenderer.cc 中，您可以包含 CairoRendererImpl.h 文件（它将获取 cairo.h 内容，但此时这正是您真正想要/需要的）。

哈，
小时

Answer 3

我认为 struct CairoRenderer::CairoRendererImpl 是错误的。由于您不使用名称空间，因此像这样的简单定义就足够了：

struct CairoRendererImpl 
{
    ...
}

此外，您还必须稍微调整您的 CairoRenderer 类：

struct CairoRendererImpl;

class CairoRenderer
{
...
protected:
    CairoRendererImpl* m_pimpl;
};