Qt D指针-私有实现

2015-07-25 15:00:00 by dragondjf

D指针-私有实现

1. 问题来源

在Qt源代码经常会出现Private类和Q_DECLARE_PRIVATE、Q_DECLARE_PUBLIC、Q_D、Q_Q等宏，这些都是什么东东？简而言之，保证代码的二进制兼容性。

2. 什么是二进制兼容性？

什么是二进制兼容性？大名鼎鼎的KDE项目是这样介绍的：一个库是二进制兼容的，如果一个程序和某个库的某个版本动态链接，并且不需要重新编译，即可在安装有该库较新版本的环境中运行。为什么要保证二进制兼容性？如果不能保证库的二进制兼容性，就意味着每次发布新版本时，依赖该库的所有程序都必须重新编译才能正常运行。显然，这对于像Qt这样被广泛采用的库而言是完全不可接受的。

3. Qt中关于D指针的的宏定义

    template <typename T> static inline T *qGetPtrHelper(T *ptr) { return ptr; }
    template <typename Wrapper> static inline typename Wrapper::pointer qGetPtrHelper(const Wrapper &p) { return p.data(); }

    #define Q_DECLARE_PRIVATE(Class) \
        inline Class##Private* d_func() { return reinterpret_cast<Class##Private *>(qGetPtrHelper(d_ptr)); } \
        inline const Class##Private* d_func() const { return reinterpret_cast<const Class##Private *>(qGetPtrHelper(d_ptr)); } \
        friend class Class##Private;

    #define Q_DECLARE_PRIVATE_D(Dptr, Class) \
        inline Class##Private* d_func() { return reinterpret_cast<Class##Private *>(Dptr); } \
        inline const Class##Private* d_func() const { return reinterpret_cast<const Class##Private *>(Dptr); } \
        friend class Class##Private;

    #define Q_DECLARE_PUBLIC(Class)                                    \
        inline Class* q_func() { return static_cast<Class *>(q_ptr); } \
        inline const Class* q_func() const { return static_cast<const Class *>(q_ptr); } \
        friend class Class;

    #define Q_D(Class) Class##Private * const d = d_func()
    #define Q_Q(Class) Class * const q = q_func()

在公有类中定义了一个指针d_ptr指向私有实现类，然后用Q_DECLARE_PRIVATE宏来定义一些辅助函数和声明友元类；
- d_func() 返回私有类指针
- 在公有类的接口实现中可以通过宏定义 Q_D(Class)来获取指向私有类的d_ptr指针，并赋值给d,直接操作d即可；
在私有实现类中定义一个指针q_ptr指向公开类（公开类向外提供接口），然后Q_DECLARE_PUBLIC宏则定义了辅助函数并声明了友元类
- q_func() 返回公有类指针
- 在私有类的接口实现中可以通过宏定义Q_Q(Class)来获取指向公有类的q_ptr指针，并赋值给变量,直接操作q即可

4. Demo

// myclass.h
#ifndef MYCLASS_H
#define MYCLASS_H
#include <QtCore/QObject>
class MyClassPrivate;
class MyClass: public QObject
{
    Q_OBJECT
public:
    MyClass(QObject *parent = 0);
    virtual ~MyClass();
    void dummyFunc();
signal:
    void dummySignal();
private:
    MyClassPrivate * const d_ptr;
    Q_DECLARE_PRIVATE(MyClass);
    Q_DISABLE_COPY(MyClass);
};
#endif // MYCLASS_H


// myclass.cpp
#include "myclass.h"
class MyClassPrivate
{
public:
    MyClassPrivate(MyClass *parent)
        : q_ptr(parent)
    {
    }
    void foobar()
    {
        Q_Q(MyClass);
        emit q->dummySignal();
    }
private:
    MyClass * const q_ptr;
    Q_DECLARE_PUBLIC(MyClass);
};

MyClass::MyClass(QObject *parent)
  : QObject(parent)
  , d_ptr(new MyClassPrivate(this))
{
}
MyClass::~MyClass()
{
    Q_D(MyClass);
    delete d;
}
void MyClass::dummyFunc()
{
    Q_D(MyClass);
    d->foobar();
}

参考：