具有写入时复制的多态类的 QList?

QList of a polymorphic class with copy-on-write?

本文关键字:多态 QList 复制      更新时间:2023-10-16

我正在尝试创建一个仍然使用Qt隐式共享的多态类型的QList。

我的具体用例是将QList中保存的项目传递给QtConcurrent::mapped。这些项目都来自一个基类,该基类定义了一个 QtConcurrent::map 将调用的虚函数。存储的大部分数据将是特定于子类的。线程开始后可能会编辑这些项目,给我留下两个主要选项,锁定或复制数据。我不想插入锁定,因为这会消除使用额外线程的大部分目的。制作我数据的完整副本似乎也很不可取。相反,我想使用 Qt 的隐式共享来仅复制我更改的数据项,但是我似乎无法制作仍然使用隐式共享的多态类型的 QList。

默认情况下,QList 使用隐式共享,因此乍一看,我们似乎已经完成了。

QList<Base> list;
Derived derived_obj;
list.append(derived_obj); // this fails

但是,将子类附加到父类的 QList 将不起作用,标准答案是改用 QSharedPointer 的 QList 到基类,这将接受将指针附加到子类。

QList<QSharedPointer<Base> > pointer_list;
QSharedPointer<Derived> derived_pointer;
pointer_list.append(derived_pointer); // this works but there is no copy-on-write

如果我使用 QSharedPointer 的QList,将被复制的是 QSharedPointer 而不是我的多态类,这意味着我失去了我想要的写入时复制功能。

我还考虑过使用QSharedDataPointers的QList。

QList<QSharedDataPointer<Base> > data_pointer_list;
QSharedDataPointer<Derived> derived_data_pointer;
list.append(derived_data_pointer); // this fails

然而,就像QList本身一样,QSharedDataPointers似乎不接受多态类型。

此操作失败:

QList<QSharedDataPointer<Base>> list;
QSharedDataPointer<Derived> derived(new Derived);
list.append(derived);

注意下面的另一种方法是合并PolymorphicSharedPolymorphicSharedBase以将多态性支持直接添加到QSharedDataPointer,而不对QSharedData派生类型提出特殊要求(例如,它不需要显式支持clone)。这需要更多的工作。以下只是一种工作方法。

QSharedDataPointer确实是你寻求的答案,绝对可以持有多态QSharedData。您需要将类型分成一个基于QSharedData的层次结构,以及另一个包装QSharedDataPointer的并行层次结构。QSharedDataPointer通常不是由类的最终用户直接使用的。这是一个实现细节,在实现隐式共享类时很有用。

为了提高效率,QSharedDataPointer是一种可以在位级别移动的小型类型。当存储在各种容器中时,它非常有效 - 特别是在可以利用类型特征来了解此属性的Qt容器中。如果我们自己使QSharedDataPointer的类的大小增加一倍,则使用它本身是多态的,因此不这样做会有所帮助。当然,指向数据类型可以是多态的。

首先,让我们定义一个相当通用的基类 PIMPL,您将在其上构建层次结构。PIMPL 类可以转储到调试流中并克隆。

// https://github.com/KubaO/stackoverflown/tree/master/questions/implicit-list-44593216
#include <QtCore>
#include <type_traits>
class PolymorphicSharedData : public QSharedData {
public:
virtual PolymorphicSharedData * clone() const = 0;
virtual QDebug dump(QDebug) const = 0;
virtual ~PolymorphicSharedData() {}
};

xxxData类型是 PIMPL,不适合最终用户使用。用户应使用xxx类型本身。然后,此共享类型包装多态 PIMPL 并使用QSharedDataPointer来存储 PIMPL。它公开了PIMPL的方法。

类型本身不是多态的,以节省虚拟表指针的大小。as()函数的作用与dynamic_cast()一样,通过将多态性重定向到 PIMPL。

class PolymorphicShared {
protected:
QSharedDataPointer<PolymorphicSharedData> d_ptr;
PolymorphicShared(PolymorphicSharedData * d) : d_ptr(d) {}
public:
PolymorphicShared() = default;
PolymorphicShared(const PolymorphicShared & o) = default;
PolymorphicShared & operator=(const PolymorphicShared &) = default;
QDebug dump(QDebug dbg) const { return d_ptr->dump(dbg); }
template <class T> typename
std::enable_if<std::is_pointer<T>::value, typename
std::enable_if<!std::is_const<typename std::remove_pointer<T>::type>::value, T>::type>
::type as() {
if (dynamic_cast<typename std::remove_pointer<T>::type::PIMPL*>(d_ptr.data()))
return static_cast<T>(this);
return {};
}
template <class T> typename
std::enable_if<std::is_pointer<T>::value, typename
std::enable_if<std::is_const<typename std::remove_pointer<T>::type>::value, T>::type>
::type as() const {
if (dynamic_cast<const typename std::remove_pointer<T>::type::PIMPL*>(d_ptr.data()))
return static_cast<T>(this);
return {};
}
template <class T> typename
std::enable_if<std::is_reference<T>::value, typename
std::enable_if<!std::is_const<typename std::remove_reference<T>::type>::value, T>::type>
::type as() {
Q_UNUSED(dynamic_cast<typename std::remove_reference<T>::type::PIMPL&>(*d_ptr));
return static_cast<T>(*this);
}
template <class T> typename
std::enable_if<std::is_reference<T>::value, typename
std::enable_if<std::is_const<typename std::remove_reference<T>::type>::value, T>::type>
::type as() const {
Q_UNUSED(dynamic_cast<const typename std::remove_reference<T>::type::PIMPL&>(*d_ptr));
return static_cast<T>(*this);
}
int ref() const { return d_ptr ? d_ptr->ref.load() : 0; }
};
QDebug operator<<(QDebug dbg, const PolymorphicShared & val) {
return val.dump(dbg);
}
Q_DECLARE_TYPEINFO(PolymorphicShared, Q_MOVABLE_TYPE);
#define DECLARE_TYPEINFO(concreteType) Q_DECLARE_TYPEINFO(concreteType, Q_MOVABLE_TYPE)
template <> PolymorphicSharedData * QSharedDataPointer<PolymorphicSharedData>::clone() {
return d->clone();
}

一个帮助程序,用于使抽象基类与派生数据类型一起使用变得容易。它将 d-ptr 强制转换为正确的派生 PIMPL 类型,并将构造函数参数转发给 PIMPL 的构造函数。

template <class Data, class Base = PolymorphicShared> class PolymorphicSharedBase : public Base {
friend class PolymorphicShared;
protected:
using PIMPL = typename std::enable_if<std::is_base_of<PolymorphicSharedData, Data>::value, Data>::type;
PIMPL * d() { return static_cast<PIMPL*>(&*this->d_ptr); }
const PIMPL * d() const { return static_cast<const PIMPL*>(&*this->d_ptr); }
PolymorphicSharedBase(PolymorphicSharedData * d) : Base(d) {}
template <typename T> static typename std::enable_if<std::is_constructible<T>::value, T*>::type
construct() { return new T(); }
template <typename T> static typename std::enable_if<!std::is_constructible<T>::value, T*>::type
construct() { return nullptr; }
public:
using Base::Base;
template<typename ...Args,
typename = typename std::enable_if<std::is_constructible<Data, Args...>::value>::type
> PolymorphicSharedBase(Args&&... args) :
Base(static_cast<PolymorphicSharedData*>(new Data(std::forward<Args>(args)...))) {}
PolymorphicSharedBase() : Base(construct<Data>()) {}
};

现在,拥有 PIMPL 类型及其载体的并行层次结构是一件简单的事情。首先,在我们的层次结构中添加两个方法的基本抽象类型。请注意PolymorphicSharedBase如何添加正确类型的d()访问器。

class MyAbstractTypeData : public PolymorphicSharedData {
public:
virtual void gurgle() = 0;
virtual int gargle() const = 0;
};
class MyAbstractType : public PolymorphicSharedBase<MyAbstractTypeData> {
public:
using PolymorphicSharedBase::PolymorphicSharedBase;
void gurgle() { d()->gurgle(); }
int gargle() const { return d()->gargle(); }
};
DECLARE_TYPEINFO(MyAbstractType);

然后,不添加新方法的具体类型:

class FooTypeData : public MyAbstractTypeData {
protected:
int m_foo = 0;
public:
FooTypeData() = default;
FooTypeData(int data) : m_foo(data) {}
void gurgle() override { m_foo++; }
int gargle() const override { return m_foo; }
MyAbstractTypeData * clone() const override { return new FooTypeData(*this); }
QDebug dump(QDebug dbg) const override {
return dbg << "FooType-" << ref << ":" << m_foo;
}
};
using FooType = PolymorphicSharedBase<FooTypeData, MyAbstractType>;
DECLARE_TYPEINFO(FooType);

还有另一种添加方法的类型。

class BarTypeData : public FooTypeData {
protected:
int m_bar = 0;
public:
BarTypeData() = default;
BarTypeData(int data) : m_bar(data) {}
MyAbstractTypeData * clone() const override { return new BarTypeData(*this); }
QDebug dump(QDebug dbg) const override {
return dbg << "BarType-" << ref << ":" << m_foo << "," << m_bar;
}
virtual void murgle() { m_bar++; }
};
class BarType : public PolymorphicSharedBase<BarTypeData, FooType> {
public:
using PolymorphicSharedBase::PolymorphicSharedBase;
void murgle() { d()->murgle(); }
};
DECLARE_TYPEINFO(BarType);

我们需要验证as()方法是否根据需要引发:

template <typename F> bool is_bad_cast(F && fun) {
try { fun(); } catch (std::bad_cast) { return true; }
return false;
}

隐式共享类型的使用与Qt自己的此类类型的使用没有什么不同。我们也可以使用as而不是dynamic_cast进行铸造。

int main() {
Q_ASSERT(sizeof(FooType) == sizeof(void*));
MyAbstractType a;
Q_ASSERT(!a.as<FooType*>());
FooType foo;
Q_ASSERT(foo.as<FooType*>());
a = foo;
Q_ASSERT(a.ref() == 2);
Q_ASSERT(a.as<const FooType*>());
Q_ASSERT(a.ref() == 2);
Q_ASSERT(a.as<FooType*>());
Q_ASSERT(a.ref() == 1);
MyAbstractType a2(foo);
Q_ASSERT(a2.ref() == 2);
QList<MyAbstractType> list1{FooType(3), BarType(8)};
auto list2 = list1;
qDebug() << "After copy:         " << list1 << list2;
list2.detach();
qDebug() << "After detach:       " << list1 << list2;
list1[0].gurgle();
qDebug() << "After list1[0] mod: " << list1 << list2;
Q_ASSERT(list2[1].as<BarType*>());
list2[1].as<BarType&>().murgle();
qDebug() << "After list2[1] mod: " << list1 << list2;
Q_ASSERT(!list2[0].as<BarType*>());
Q_ASSERT(is_bad_cast([&]{ list2[0].as<BarType&>(); }));
auto const list3 = list1;
Q_ASSERT(!list3[0].as<const BarType*>());
Q_ASSERT(is_bad_cast([&]{ list3[0].as<const BarType&>(); }));
}

输出:

After copy:          (FooType-1:3, BarType-1:0,8) (FooType-1:3, BarType-1:0,8)
After detach:        (FooType-2:3, BarType-2:0,8) (FooType-2:3, BarType-2:0,8)
After list1[0] mod:  (FooType-1:4, BarType-2:0,8) (FooType-1:3, BarType-2:0,8)
After list2[1] mod:  (FooType-1:4, BarType-1:0,8) (FooType-1:3, BarType-1:0,9)

列表副本很浅,项目本身没有被复制:引用计数都是1的。分离后,将复制所有数据项,但由于它们是隐式共享的,因此它们仅增加了其引用计数。最后,修改项目后,它会自动分离,引用计数回落到 1。