探究Qt5【元对象编译器，moc】的设计原理和技术细节

Qt5是一个跨平台C++框架，它有个突出的特点就是其元对象系统，该系统通过扩展C++的能力，为事件处理提供了信号与槽机制、为对象内省提供了属性系统。为了支持这些特性，Qt引入了元对象编译器（Meta-Object Compiler, MOC），这用于解析C++头文件并生成附加的源代码，并与其他代码一起编译，实现元对象系统的功能。
Qt的元对象编译器是Qt中相对复杂的一个部分，因此本文深入moc的技术细节，为你揭开Qt元对象系统神秘的面纱。

moc的工作原理

moc会读取C++源文件，寻找Qt特定的宏，如Q_OBJECT、signals、slots和Q_PROPERTY。当它发现这些宏时，它会生成一个C++源文件，其中包含了类的元信息，然后将这个文件以合适的方式编译和链接到应用程序中。具体的链接细节可以参考文章《在Qt中，直接include ＜moc_xxxxx.cpp＞为什么不会出现符号冲突的错误？》。

生成的代码信息比较多，具体来说，moc生成的代码包括：

元对象代码，提供了关于对象的信息，例如其类名、超类名、方法、属性和信号/槽。
信号和槽的实现，使得信号-槽连接机制成为可能，允许对象之间进行松耦合的通信。
动态属性系统代码，允许在运行时内省和修改对象属性。

这些生成代码一般在Build目录下/XXX/XXX_autogen，例如：
在这里插入图片描述

moc示例与代码

我们可以通过一个简单的例子来观察moc的原理。
假设我们有一个MyObject.h头文件，其中定义了一个类：

#ifndef MYOBJECT_H
#define MYOBJECT_H#include <QObject>class MyObject : public QObject {Q_OBJECTQ_PROPERTY(int myProperty READ myProperty WRITE setMyProperty NOTIFY myPropertyChanged)public:MyObject() : m_myProperty(0) {}int myProperty() const { return m_myProperty; }void setMyProperty(int value) {if (value != m_myProperty) {m_myProperty = value;emit myPropertyChanged(value);}}signals:void myPropertyChanged(int newValue);private:int m_myProperty;
};#endif // MYOBJECT_H

在这个类中，我们有一个属性myProperty以及对应的getter和setter方法，还有一个在属性改变时会发射的信号myPropertyChanged。为了让这个类可以使用Qt的元对象系统，类定义中包含了Q_OBJECT宏。

当你编译时，构建系统会先调用qmake.exe，对源码进行扫描。这个步骤以CMake生成的VisualStudio为例，在PreBuild阶段：
在这里插入图片描述

moc会生成一个源文件（通常命名为moc_MyObject.cpp），它包含了MyObject的元对象代码。生成代码的简化节选如下所示：

// moc_MyObject.cpp
#include "MyObject.h"// MyObject的元对象代码
static const QtMetaObject staticMetaObject = {{ &QObject::staticMetaObject, qt_meta_stringdata_MyObject,qt_meta_data_MyObject,  qt_static_metacall, nullptr, nullptr }
};void MyObject::qt_static_metacall(QObject *_obj, QMetaObject::Call _c, int _id, void **_a) {if (_c == QMetaObject::InvokeMetaMethod) {MyObject *_t = static_cast<MyObject *>(_obj);Q_UNUSED(_t)switch (_id) {case 0: _t->myPropertyChanged((*reinterpret_cast< int(*)>(_a[1]))); break;default: ;}}
}const QMetaObject *MyObject::metaObject() const {return QObject::d_ptr->metaObject ? QObject::d_ptr->metaObject : &staticMetaObject;
}// 还会生成信号和属性系统的实现代码...

这些都是元对象系统工作所需的生成的代码，包括类的元对象信息，静态调用函数用于调用方法和访问属性，以及其他必要的函数。

完整的代码如下：

/****************************************************************************
** Meta object code from reading C++ file 'MyObject.cpp'
**
** Created by: The Qt Meta Object Compiler version 67 (Qt 5.15.16)
**
** WARNING! All changes made in this file will be lost!
*****************************************************************************/#include <memory>
#include <QtCore/qbytearray.h>
#include <QtCore/qmetatype.h>
#if !defined(Q_MOC_OUTPUT_REVISION)
#error "The header file 'MyObject.cpp' doesn't include <QObject>."
#elif Q_MOC_OUTPUT_REVISION != 67
#error "This file was generated using the moc from 5.15.16. It"
#error "cannot be used with the include files from this version of Qt."
#error "(The moc has changed too much.)"
#endifQT_BEGIN_MOC_NAMESPACE
QT_WARNING_PUSH
QT_WARNING_DISABLE_DEPRECATED
struct qt_meta_stringdata_MyObject_t {QByteArrayData data[5];char stringdata0[48];
};
#define QT_MOC_LITERAL(idx, ofs, len) \Q_STATIC_BYTE_ARRAY_DATA_HEADER_INITIALIZER_WITH_OFFSET(len, \qptrdiff(offsetof(qt_meta_stringdata_MyObject_t, stringdata0) + ofs \- idx * sizeof(QByteArrayData)) \)
static const qt_meta_stringdata_MyObject_t qt_meta_stringdata_MyObject = {{
QT_MOC_LITERAL(0, 0, 8), // "MyObject"
QT_MOC_LITERAL(1, 9, 17), // "myPropertyChanged"
QT_MOC_LITERAL(2, 27, 0), // ""
QT_MOC_LITERAL(3, 28, 8), // "newValue"
QT_MOC_LITERAL(4, 37, 10) // "myProperty"},"MyObject\0myPropertyChanged\0\0newValue\0""myProperty"
};
#undef QT_MOC_LITERALstatic const uint qt_meta_data_MyObject[] = {// content:8,       // revision0,       // classname0,    0, // classinfo1,   14, // methods1,   22, // properties0,    0, // enums/sets0,    0, // constructors0,       // flags1,       // signalCount// signals: name, argc, parameters, tag, flags1,    1,   19,    2, 0x06 /* Public */,// signals: parametersQMetaType::Void, QMetaType::Int,    3,// properties: name, type, flags4, QMetaType::Int, 0x00495103,// properties: notify_signal_id0,0        // eod
};void MyObject::qt_static_metacall(QObject *_o, QMetaObject::Call _c, int _id, void **_a)
{if (_c == QMetaObject::InvokeMetaMethod) {auto *_t = static_cast<MyObject *>(_o);(void)_t;switch (_id) {case 0: _t->myPropertyChanged((*reinterpret_cast< int(*)>(_a[1]))); break;default: ;}} else if (_c == QMetaObject::IndexOfMethod) {int *result = reinterpret_cast<int *>(_a[0]);{using _t = void (MyObject::*)(int );if (*reinterpret_cast<_t *>(_a[1]) == static_cast<_t>(&MyObject::myPropertyChanged)) {*result = 0;return;}}}
#ifndef QT_NO_PROPERTIESelse if (_c == QMetaObject::ReadProperty) {auto *_t = static_cast<MyObject *>(_o);(void)_t;void *_v = _a[0];switch (_id) {case 0: *reinterpret_cast< int*>(_v) = _t->myProperty(); break;default: break;}} else if (_c == QMetaObject::WriteProperty) {auto *_t = static_cast<MyObject *>(_o);(void)_t;void *_v = _a[0];switch (_id) {case 0: _t->setMyProperty(*reinterpret_cast< int*>(_v)); break;default: break;}} else if (_c == QMetaObject::ResetProperty) {}
#endif // QT_NO_PROPERTIES
}QT_INIT_METAOBJECT const QMetaObject MyObject::staticMetaObject = { {QMetaObject::SuperData::link<QObject::staticMetaObject>(),qt_meta_stringdata_MyObject.data,qt_meta_data_MyObject,qt_static_metacall,nullptr,nullptr
} };const QMetaObject *MyObject::metaObject() const
{return QObject::d_ptr->metaObject ? QObject::d_ptr->dynamicMetaObject() : &staticMetaObject;
}void *MyObject::qt_metacast(const char *_clname)
{if (!_clname) return nullptr;if (!strcmp(_clname, qt_meta_stringdata_MyObject.stringdata0))return static_cast<void*>(this);return QObject::qt_metacast(_clname);
}int MyObject::qt_metacall(QMetaObject::Call _c, int _id, void **_a)
{_id = QObject::qt_metacall(_c, _id, _a);if (_id < 0)return _id;if (_c == QMetaObject::InvokeMetaMethod) {if (_id < 1)qt_static_metacall(this, _c, _id, _a);_id -= 1;} else if (_c == QMetaObject::RegisterMethodArgumentMetaType) {if (_id < 1)*reinterpret_cast<int*>(_a[0]) = -1;_id -= 1;}
#ifndef QT_NO_PROPERTIESelse if (_c == QMetaObject::ReadProperty || _c == QMetaObject::WriteProperty|| _c == QMetaObject::ResetProperty || _c == QMetaObject::RegisterPropertyMetaType) {qt_static_metacall(this, _c, _id, _a);_id -= 1;} else if (_c == QMetaObject::QueryPropertyDesignable) {_id -= 1;} else if (_c == QMetaObject::QueryPropertyScriptable) {_id -= 1;} else if (_c == QMetaObject::QueryPropertyStored) {_id -= 1;} else if (_c == QMetaObject::QueryPropertyEditable) {_id -= 1;} else if (_c == QMetaObject::QueryPropertyUser) {_id -= 1;}
#endif // QT_NO_PROPERTIESreturn _id;
}// SIGNAL 0
void MyObject::myPropertyChanged(int _t1)
{void *_a[] = { nullptr, const_cast<void*>(reinterpret_cast<const void*>(std::addressof(_t1))) };QMetaObject::activate(this, &staticMetaObject, 0, _a);
}
QT_WARNING_POP
QT_END_MOC_NAMESPACE

moc代码生成背后的原理

moc生成的代码启用了几个重要特性：

信号和槽（Signals and Slots）：元对象代码允许Qt的信号-槽机制使用QObject::connect()来连接信号和槽。当一个信号被发射时，通过元对象系统调用相应的槽函数。
属性系统（Property System）：属性系统代码允许在运行时使用QObject::property()和QObject::setProperty()来访问和修改属性。它也使得Qt的属性动画系统得以使用。
内省（Introspection）：元对象包含了关于类的信息，允许应用程序通过通用接口来查询和与对象交互。
动态对象系统（Dynamic Object System）：元对象生成的代码支持了在运行时查询对象能力和动态调用方法的能力。

解读Qt5 moc生成的元对象代码

接下来，我们对上面生成的moc_MyObject.cpp源码进行解析。

包含宏和错误检查

首先，生成的代码包含了一些预处理宏和错误检查：

#include <QtCore/qbytearray.h>
#include <QtCore/qmetatype.h>
#if !defined(Q_MOC_OUTPUT_REVISION)
#error "The header file 'code.cpp' doesn't include <QObject>."
#elif Q_MOC_OUTPUT_REVISION != 67
#error "This file was generated using the moc from 5.15.16. It"
#error "cannot be used with the include files from this version of Qt."
#error "(The moc has changed too much.)"
#endif

这些检查确保了MyObject.cpp包含了<QObject>头文件，并且moc版本与Qt版本相匹配。

元字符串数据

接下来是元字符串数据的定义：

struct qt_meta_stringdata_MyObject_t {QByteArrayData data[5];char stringdata0[48];
};
#define QT_MOC_LITERAL(idx, ofs, len) \Q_STATIC_BYTE_ARRAY_DATA_HEADER_INITIALIZER_WITH_OFFSET(len, \qptrdiff(offsetof(qt_meta_stringdata_MyObject_t, stringdata0) + ofs \- idx * sizeof(QByteArrayData)) \)
static const qt_meta_stringdata_MyObject_t qt_meta_stringdata_MyObject = {{
QT_MOC_LITERAL(0, 0, 8), // "MyObject"
QT_MOC_LITERAL(1, 9, 17), // "myPropertyChanged"
QT_MOC_LITERAL(2, 27, 0), // ""
QT_MOC_LITERAL(3, 28, 8), // "newValue"
QT_MOC_LITERAL(4, 37, 10) // "myProperty"},"MyObject\0myPropertyChanged\0\0newValue\0""myProperty"
};

这个结构体存储了类名、信号名称和参数名。该结构体被用于在运行时检索类和成员的名称。

元数据属性数组

元数据属性数组qt_meta_data_MyObject包含了关于类、信号和属性的信息：

static const uint qt_meta_data_MyObject[] = {// content:8,       // revision0,       // classname0,    0, // classinfo1,   14, // methods1,   22, // properties0,    0, // enums/sets0,    0, // constructors0,       // flags1,       // signalCount// signals: name, argc, parameters, tag, flags1,    1,   19,    2, 0x06 /* Public */,// signals: parametersQMetaType::Void, QMetaType::Int,    3,// properties: name, type, flags4, QMetaType::Int, 0x00495103,// properties: notify_signal_id0,0        // eod
};

这个数组包含了信号的数量、信号的名称、参数类型、属性的名称和类型等信息，它们用于在运行时进行方法调用、属性访问和信号发射。

静态元调用

函数qt_static_metacall是moc生成的一个重要函数，它负责转发信号、访问属性和响应其他元对象调用：

void MyObject::qt_static_metacall(QObject *_o, QMetaObject::Call _c, int _id, void **_a) {// ... 处理元对象调用的代码 ...
}

元对象初始化

staticMetaObject是一个QMetaObject结构体的实例，包含了指向元字符串数据和元数据的指针，以及指向qt_static_metacall函数的指针：

QT_INIT_METAOBJECT const QMetaObject MyObject::staticMetaObject = {// ... 元对象初始化数据 ...
};

元对象函数

metaObject、qt_metacast和qt_metacall函数实现了Qt的动态类型识别和方法调用：

const QMetaObject *MyObject::metaObject() const {// 返回元对象的指针
}void *MyObject::qt_metacast(const char *_clname) {// 动态类型转换
}int MyObject::qt_metacall(QMetaObject::Call _c, int _id, void **_a) {// 处理动态方法调用
}

信号实现

最后，moc为每个信号生成了一个实现，它使用QMetaObject::activate函数来发射信号：

void MyObject::myPropertyChanged(int _t1) {void *_a[] = { nullptr, const_cast<void*>(reinterpret_cast<const void*>(std::addressof(_t1))) };QMetaObject::activate(this, &staticMetaObject, 0, _a);
}