qtdeclarative/src/qml/jsruntime/qv4sequenceobject.cpp

693 lines
21 KiB
C++

// Copyright (C) 2016 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
#include <QtCore/qsequentialiterable.h>
#include "qv4sequenceobject_p.h"
#include <private/qv4functionobject_p.h>
#include <private/qv4arrayobject_p.h>
#include <private/qqmlengine_p.h>
#include <private/qv4scopedvalue_p.h>
#include <private/qv4jscall_p.h>
#include <private/qqmlmetatype_p.h>
#include <private/qqmltype_p_p.h>
#include <algorithm>
QT_BEGIN_NAMESPACE
namespace QV4 {
DEFINE_OBJECT_VTABLE(Sequence);
static const QMetaSequence *metaSequence(const Heap::Sequence *p)
{
return p->typePrivate->extraData.ld;
}
template<typename Compare>
void sortSequence(Sequence *sequence, const Compare &compare)
{
const auto *p = sequence->d();
const auto *m = metaSequence(p);
QSequentialIterable iterable(*m, p->typePrivate->listId, p->container);
if (iterable.canRandomAccessIterate()) {
std::sort(QSequentialIterable::RandomAccessIterator(iterable.mutableBegin()),
QSequentialIterable::RandomAccessIterator(iterable.mutableEnd()),
compare);
} else if (iterable.canReverseIterate()) {
std::sort(QSequentialIterable::BidirectionalIterator(iterable.mutableBegin()),
QSequentialIterable::BidirectionalIterator(iterable.mutableEnd()),
compare);
} else {
qWarning() << "Container has no suitable iterator for sorting";
}
}
// helper function to generate valid warnings if errors occur during sequence operations.
static void generateWarning(QV4::ExecutionEngine *v4, const QString& description)
{
QQmlEngine *engine = v4->qmlEngine();
if (!engine)
return;
QQmlError retn;
retn.setDescription(description);
QV4::CppStackFrame *stackFrame = v4->currentStackFrame;
retn.setLine(stackFrame->lineNumber());
retn.setUrl(QUrl(stackFrame->source()));
QQmlEnginePrivate::warning(engine, retn);
}
struct SequenceOwnPropertyKeyIterator : ObjectOwnPropertyKeyIterator
{
~SequenceOwnPropertyKeyIterator() override = default;
PropertyKey next(const Object *o, Property *pd = nullptr, PropertyAttributes *attrs = nullptr) override
{
const Sequence *s = static_cast<const Sequence *>(o);
if (s->d()->isReference) {
if (!s->d()->object)
return ObjectOwnPropertyKeyIterator::next(o, pd, attrs);
s->loadReference();
}
const qsizetype size = s->size();
if (size > 0 && qIsAtMostSizetypeLimit(arrayIndex, size - 1)) {
const uint index = arrayIndex;
++arrayIndex;
if (attrs)
*attrs = QV4::Attr_Data;
if (pd)
pd->value = s->engine()->fromVariant(s->at(qsizetype(index)));
return PropertyKey::fromArrayIndex(index);
}
if (memberIndex == 0) {
++memberIndex;
return o->engine()->id_length()->propertyKey();
}
// You cannot add any own properties via the regular JavaScript interfaces.
return PropertyKey::invalid();
}
};
struct SequenceCompareFunctor
{
SequenceCompareFunctor(QV4::ExecutionEngine *v4, const QV4::Value &compareFn)
: m_v4(v4), m_compareFn(&compareFn)
{}
bool operator()(const QVariant &lhs, const QVariant &rhs)
{
QV4::Scope scope(m_v4);
ScopedFunctionObject compare(scope, m_compareFn);
if (!compare)
return m_v4->throwTypeError();
Value *argv = scope.alloc(2);
argv[0] = m_v4->fromVariant(lhs);
argv[1] = m_v4->fromVariant(rhs);
QV4::ScopedValue result(scope, compare->call(m_v4->globalObject, argv, 2));
if (scope.hasException())
return false;
return result->toNumber() < 0;
}
private:
QV4::ExecutionEngine *m_v4;
const QV4::Value *m_compareFn;
};
struct SequenceDefaultCompareFunctor
{
bool operator()(const QVariant &lhs, const QVariant &rhs)
{
return lhs.toString() < rhs.toString();
}
};
void Heap::Sequence::init(const QQmlType &qmlType, const void *container)
{
Object::init();
Q_ASSERT(qmlType.isSequentialContainer());
typePrivate = qmlType.priv();
QQmlType::refHandle(typePrivate);
this->container = typePrivate->listId.create(container);
propertyIndex = -1;
isReference = false;
isReadOnly = false;
object.init();
QV4::Scope scope(internalClass->engine);
QV4::Scoped<QV4::Sequence> o(scope, this);
o->setArrayType(Heap::ArrayData::Custom);
}
void Heap::Sequence::init(
QObject *object, int propertyIndex, const QQmlType &qmlType, bool readOnly)
{
Object::init();
Q_ASSERT(qmlType.isSequentialContainer());
typePrivate = qmlType.priv();
QQmlType::refHandle(typePrivate);
container = QMetaType(typePrivate->listId).create();
this->propertyIndex = propertyIndex;
isReference = true;
this->isReadOnly = readOnly;
this->object.init(object);
QV4::Scope scope(internalClass->engine);
QV4::Scoped<QV4::Sequence> o(scope, this);
o->setArrayType(Heap::ArrayData::Custom);
o->loadReference();
}
void Heap::Sequence::destroy()
{
typePrivate->listId.destroy(container);
QQmlType::derefHandle(typePrivate);
object.destroy();
Object::destroy();
}
const QMetaType Sequence::valueMetaType(const Heap::Sequence *p)
{
return p->typePrivate->typeId;
}
qsizetype Sequence::size() const
{
const auto *p = d();
return metaSequence(p)->size(p->container);
}
QVariant Sequence::at(qsizetype index) const
{
const auto *p = d();
const QMetaType v = valueMetaType(p);
QVariant result;
if (v == QMetaType::fromType<QVariant>()) {
metaSequence(p)->valueAtIndex(p->container, index, &result);
} else {
result = QVariant(v);
metaSequence(p)->valueAtIndex(p->container, index, result.data());
}
return result;
}
template<typename Action>
void convertAndDo(const QVariant &item, const QMetaType v, Action action)
{
if (item.metaType() == v) {
action(item.constData());
} else if (v == QMetaType::fromType<QVariant>()) {
action(&item);
} else {
QVariant converted = item;
if (!converted.convert(v))
converted = QVariant(v);
action(converted.constData());
}
}
void Sequence::append(const QVariant &item)
{
const Heap::Sequence *p = d();
convertAndDo(item, valueMetaType(p), [p](const void *data) {
metaSequence(p)->addValueAtEnd(p->container, data);
});
}
void Sequence::append(qsizetype num, const QVariant &item)
{
const Heap::Sequence *p = d();
convertAndDo(item, valueMetaType(p), [p, num](const void *data) {
const QMetaSequence *m = metaSequence(p);
void *container = p->container;
for (qsizetype i = 0; i < num; ++i)
m->addValueAtEnd(container, data);
});
}
void Sequence::replace(qsizetype index, const QVariant &item)
{
const Heap::Sequence *p = d();
convertAndDo(item, valueMetaType(p), [p, index](const void *data) {
metaSequence(p)->setValueAtIndex(p->container, index, data);
});
}
void Sequence::removeLast(qsizetype num)
{
const auto *p = d();
const auto *m = metaSequence(p);
if (m->canEraseRangeAtIterator() && m->hasRandomAccessIterator() && num > 1) {
void *i = m->end(p->container);
m->advanceIterator(i, -num);
void *j = m->end(p->container);
m->eraseRangeAtIterator(p->container, i, j);
m->destroyIterator(i);
m->destroyIterator(j);
} else {
for (int i = 0; i < num; ++i)
m->removeValueAtEnd(p->container);
}
}
QVariant Sequence::toVariant() const
{
const auto *p = d();
return QVariant(p->typePrivate->listId, p->container);
}
ReturnedValue Sequence::containerGetIndexed(qsizetype index, bool *hasProperty) const
{
if (d()->isReference) {
if (!d()->object) {
if (hasProperty)
*hasProperty = false;
return Encode::undefined();
}
loadReference();
}
if (index >= 0 && index < size()) {
if (hasProperty)
*hasProperty = true;
return engine()->fromVariant(at(index));
}
if (hasProperty)
*hasProperty = false;
return Encode::undefined();
}
bool Sequence::containerPutIndexed(qsizetype index, const Value &value)
{
if (internalClass()->engine->hasException)
return false;
if (d()->isReadOnly) {
engine()->throwTypeError(QLatin1String("Cannot insert into a readonly container"));
return false;
}
if (d()->isReference) {
if (!d()->object)
return false;
loadReference();
}
const qsizetype count = size();
const QMetaType valueType = valueMetaType(d());
const QVariant element = ExecutionEngine::toVariant(value, valueType, false);
if (index < 0)
return false;
if (index == count) {
append(element);
} else if (index < count) {
replace(index, element);
} else {
/* according to ECMA262r3 we need to insert */
/* the value at the given index, increasing length to index+1. */
append(index - count,
valueType == QMetaType::fromType<QVariant>() ? QVariant() : QVariant(valueType));
append(element);
}
if (d()->isReference)
storeReference();
return true;
}
SequenceOwnPropertyKeyIterator *containerOwnPropertyKeys(const Object *m, Value *target)
{
*target = *m;
return new SequenceOwnPropertyKeyIterator;
}
bool Sequence::containerDeleteIndexedProperty(qsizetype index)
{
if (d()->isReadOnly)
return false;
if (d()->isReference) {
if (!d()->object)
return false;
loadReference();
}
if (index < 0 || index >= size())
return false;
/* according to ECMA262r3 it should be Undefined, */
/* but we cannot, so we insert a default-value instead. */
replace(index, QVariant());
if (d()->isReference)
storeReference();
return true;
}
bool Sequence::containerIsEqualTo(Managed *other)
{
if (!other)
return false;
Sequence *otherSequence = other->as<Sequence>();
if (!otherSequence)
return false;
if (d()->isReference && otherSequence->d()->isReference) {
return d()->object == otherSequence->d()->object && d()->propertyIndex == otherSequence->d()->propertyIndex;
} else if (!d()->isReference && !otherSequence->d()->isReference) {
return this == otherSequence;
}
return false;
}
bool Sequence::sort(const FunctionObject *f, const Value *, const Value *argv, int argc)
{
if (d()->isReadOnly)
return false;
if (d()->isReference) {
if (!d()->object)
return false;
loadReference();
}
if (argc == 1 && argv[0].as<FunctionObject>())
sortSequence(this, SequenceCompareFunctor(f->engine(), argv[0]));
else
sortSequence(this, SequenceDefaultCompareFunctor());
if (d()->isReference)
storeReference();
return true;
}
void *Sequence::getRawContainerPtr() const
{ return d()->container; }
void Sequence::loadReference() const
{
Q_ASSERT(d()->object);
Q_ASSERT(d()->isReference);
void *a[] = { d()->container, nullptr };
QMetaObject::metacall(d()->object, QMetaObject::ReadProperty, d()->propertyIndex, a);
}
void Sequence::storeReference()
{
Q_ASSERT(d()->object);
Q_ASSERT(d()->isReference);
int status = -1;
QQmlPropertyData::WriteFlags flags = QQmlPropertyData::DontRemoveBinding;
void *a[] = { d()->container, nullptr, &status, &flags };
QMetaObject::metacall(d()->object, QMetaObject::WriteProperty, d()->propertyIndex, a);
}
ReturnedValue Sequence::virtualGet(const Managed *that, PropertyKey id, const Value *receiver, bool *hasProperty)
{
if (id.isArrayIndex()) {
const uint index = id.asArrayIndex();
if (qIsAtMostSizetypeLimit(index))
return static_cast<const Sequence *>(that)->containerGetIndexed(qsizetype(index), hasProperty);
generateWarning(that->engine(), QLatin1String("Index out of range during indexed get"));
return false;
}
return Object::virtualGet(that, id, receiver, hasProperty);
}
bool Sequence::virtualPut(Managed *that, PropertyKey id, const Value &value, Value *receiver)
{
if (id.isArrayIndex()) {
const uint index = id.asArrayIndex();
if (qIsAtMostSizetypeLimit(index))
return static_cast<Sequence *>(that)->containerPutIndexed(qsizetype(index), value);
generateWarning(that->engine(), QLatin1String("Index out of range during indexed set"));
return false;
}
return Object::virtualPut(that, id, value, receiver);
}
bool Sequence::virtualDeleteProperty(Managed *that, PropertyKey id)
{
if (id.isArrayIndex()) {
const uint index = id.asArrayIndex();
if (qIsAtMostSizetypeLimit(index))
return static_cast<Sequence *>(that)->containerDeleteIndexedProperty(qsizetype(index));
generateWarning(that->engine(), QLatin1String("Index out of range during indexed delete"));
return false;
}
return Object::virtualDeleteProperty(that, id);
}
bool Sequence::virtualIsEqualTo(Managed *that, Managed *other)
{
return static_cast<Sequence *>(that)->containerIsEqualTo(other);
}
OwnPropertyKeyIterator *Sequence::virtualOwnPropertyKeys(const Object *m, Value *target)
{
return containerOwnPropertyKeys(m, target);
}
static QV4::ReturnedValue method_get_length(const FunctionObject *b, const Value *thisObject, const Value *, int)
{
QV4::Scope scope(b);
QV4::Scoped<Sequence> This(scope, thisObject->as<Sequence>());
if (!This)
THROW_TYPE_ERROR();
if (This->d()->isReference) {
if (!This->d()->object)
RETURN_RESULT(Encode(0));
This->loadReference();
}
const qsizetype size = This->size();
if (qIsAtMostUintLimit(size))
RETURN_RESULT(Encode(uint(size)));
return scope.engine->throwRangeError(QLatin1String("Sequence length out of range"));
}
static QV4::ReturnedValue method_set_length(const FunctionObject *f, const Value *thisObject, const Value *argv, int argc)
{
QV4::Scope scope(f);
QV4::Scoped<Sequence> This(scope, thisObject->as<Sequence>());
if (!This)
THROW_TYPE_ERROR();
bool ok = false;
const quint32 argv0 = argc ? argv[0].asArrayLength(&ok) : 0;
if (!ok || !qIsAtMostSizetypeLimit(argv0)) {
generateWarning(scope.engine, QLatin1String("Index out of range during length set"));
RETURN_UNDEFINED();
}
if (This->d()->isReadOnly)
THROW_TYPE_ERROR();
const qsizetype newCount = qsizetype(argv0);
/* Read the sequence from the QObject property if we're a reference */
if (This->d()->isReference) {
if (!This->d()->object)
RETURN_UNDEFINED();
This->loadReference();
}
/* Determine whether we need to modify the sequence */
const qsizetype count = This->size();
if (newCount == count) {
RETURN_UNDEFINED();
} else if (newCount > count) {
const QMetaType valueMetaType = metaSequence(This->d())->valueMetaType();
/* according to ECMA262r3 we need to insert */
/* undefined values increasing length to newLength. */
/* We cannot, so we insert default-values instead. */
This->append(newCount - count, QVariant(valueMetaType));
} else {
/* according to ECMA262r3 we need to remove */
/* elements until the sequence is the required length. */
Q_ASSERT(newCount < count);
This->removeLast(count - newCount);
}
/* write back if required. */
if (This->d()->isReference) {
/* write back. already checked that object is non-null, so skip that check here. */
This->storeReference();
}
RETURN_UNDEFINED();
}
void SequencePrototype::init()
{
defineDefaultProperty(QStringLiteral("sort"), method_sort, 1);
defineDefaultProperty(engine()->id_valueOf(), method_valueOf, 0);
defineAccessorProperty(QStringLiteral("length"), method_get_length, method_set_length);
}
ReturnedValue SequencePrototype::method_valueOf(const FunctionObject *f, const Value *thisObject, const Value *, int)
{
return Encode(thisObject->toString(f->engine()));
}
ReturnedValue SequencePrototype::method_sort(const FunctionObject *b, const Value *thisObject, const Value *argv, int argc)
{
Scope scope(b);
QV4::ScopedObject o(scope, thisObject);
if (!o || !o->isV4SequenceType())
THROW_TYPE_ERROR();
if (argc >= 2)
return o.asReturnedValue();
if (auto *s = o->as<Sequence>()) {
if (!s->sort(b, thisObject, argv, argc))
THROW_TYPE_ERROR();
}
return o.asReturnedValue();
}
ReturnedValue SequencePrototype::newSequence(
QV4::ExecutionEngine *engine, QMetaType sequenceType, QObject *object,
int propertyIndex, bool readOnly, bool *succeeded)
{
QV4::Scope scope(engine);
// This function is called when the property is a QObject Q_PROPERTY of
// the given sequence type. Internally we store a sequence
// (as well as object ptr + property index for updated-read and write-back)
// and so access/mutate avoids variant conversion.
const QQmlType qmlType = QQmlMetaType::qmlListType(sequenceType);
if (qmlType.isSequentialContainer()) {
*succeeded = true;
QV4::ScopedObject obj(scope, engine->memoryManager->allocate<Sequence>(
object, propertyIndex, qmlType, readOnly));
return obj.asReturnedValue();
}
*succeeded = false;
return Encode::undefined();
}
ReturnedValue SequencePrototype::fromVariant(
QV4::ExecutionEngine *engine, const QVariant &v, bool *succeeded)
{
return fromData(engine, v.metaType(), v.constData(), succeeded);
}
ReturnedValue SequencePrototype::fromData(ExecutionEngine *engine, QMetaType type, const void *data, bool *succeeded)
{
QV4::Scope scope(engine);
// This function is called when assigning a sequence value to a normal JS var
// in a JS block. Internally, we store a sequence of the specified type.
// Access and mutation is extremely fast since it will not need to modify any
// QObject property.
const QQmlType qmlType = QQmlMetaType::qmlListType(type);
if (qmlType.isSequentialContainer()) {
*succeeded = true;
QV4::ScopedObject obj(scope, engine->memoryManager->allocate<Sequence>(qmlType, data));
return obj.asReturnedValue();
}
*succeeded = false;
return Encode::undefined();
}
QVariant SequencePrototype::toVariant(const Sequence *object)
{
Q_ASSERT(object->isV4SequenceType());
return object->toVariant();
}
QVariant SequencePrototype::toVariant(const QV4::Value &array, QMetaType typeHint, bool *succeeded)
{
*succeeded = true;
if (!array.as<ArrayObject>()) {
*succeeded = false;
return QVariant();
}
QV4::Scope scope(array.as<Object>()->engine());
QV4::ScopedArrayObject a(scope, array);
const QQmlType type = QQmlMetaType::qmlListType(typeHint);
if (type.isSequentialContainer()) {
const QQmlTypePrivate *priv = type.priv();
const QMetaSequence *meta = priv->extraData.ld;
const QMetaType containerMetaType(priv->listId);
QVariant result(containerMetaType);
qint64 length = a->getLength();
Q_ASSERT(length >= 0);
Q_ASSERT(length <= qint64(std::numeric_limits<quint32>::max()));
QV4::ScopedValue v(scope);
for (quint32 i = 0; i < quint32(length); ++i) {
const QMetaType valueMetaType = priv->typeId;
QVariant variant = ExecutionEngine::toVariant(a->get(i), valueMetaType, false);
if (valueMetaType == QMetaType::fromType<QVariant>()) {
meta->addValueAtEnd(result.data(), &variant);
} else {
const QMetaType originalType = variant.metaType();
if (originalType != valueMetaType) {
QVariant converted(valueMetaType);
if (QQmlValueTypeProvider::createValueType(
variant, valueMetaType, converted.data())) {
variant = converted;
} else if (!variant.convert(valueMetaType)) {
qWarning().noquote()
<< QLatin1String("Could not convert array value "
"at position %1 from %2 to %3")
.arg(QString::number(i),
QString::fromUtf8(originalType.name()),
QString::fromUtf8(valueMetaType.name()));
variant = converted;
}
}
meta->addValueAtEnd(result.data(), variant.constData());
}
}
return result;
}
*succeeded = false;
return QVariant();
}
void *SequencePrototype::getRawContainerPtr(const Sequence *object, QMetaType typeHint)
{
if (object->d()->typePrivate->listId == typeHint)
return object->getRawContainerPtr();
return nullptr;
}
QMetaType SequencePrototype::metaTypeForSequence(const Sequence *object)
{
return object->d()->typePrivate->listId;
}
} // namespace QV4
QT_END_NAMESPACE
#include "moc_qv4sequenceobject_p.cpp"