qtdeclarative/src/qml/jsruntime/qv4arraydata.cpp

/****************************************************************************
**
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the QtQml module of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:LGPL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Digia.  For licensing terms and
** conditions see http://qt.digia.com/licensing.  For further information
** use the contact form at http://qt.digia.com/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, Digia gives you certain additional
** rights.  These rights are described in the Digia Qt LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
**
**
** $QT_END_LICENSE$
**
****************************************************************************/
#include "qv4arraydata_p.h"
#include "qv4object_p.h"
#include "qv4functionobject_p.h"

using namespace QV4;

const ArrayVTable ArrayData::static_vtbl =
{
    ArrayData::Simple,
    ArrayData::freeData,
    ArrayData::reserve,
    ArrayData::get,
    ArrayData::put,
    ArrayData::putArray,
    ArrayData::del,
    ArrayData::setAttribute,
    ArrayData::attribute,
    ArrayData::push_front,
    ArrayData::pop_front,
    ArrayData::truncate
};

const ArrayVTable SparseArrayData::static_vtbl =
{
    ArrayData::Sparse,
    SparseArrayData::freeData,
    SparseArrayData::reserve,
    SparseArrayData::get,
    SparseArrayData::put,
    SparseArrayData::putArray,
    SparseArrayData::del,
    SparseArrayData::setAttribute,
    SparseArrayData::attribute,
    SparseArrayData::push_front,
    SparseArrayData::pop_front,
    SparseArrayData::truncate
};


void ArrayData::getHeadRoom(ArrayData *d)
{
    Q_ASSERT(d);
    Q_ASSERT(!d->offset);
    d->offset = qMax(d->len >> 2, (uint)16);
    SafeValue *newArray = new SafeValue[d->offset + d->alloc];
    memcpy(newArray + d->offset, d->data, d->len*sizeof(SafeValue));
    delete [] d->data;
    d->data = newArray + d->offset;
    if (d->attrs) {
        PropertyAttributes *newAttrs = new PropertyAttributes[d->offset + d->alloc];
        memcpy(newAttrs + d->offset, d->attrs, d->len*sizeof(PropertyAttributes));
        delete [] d->attrs;
        d->attrs = newAttrs + d->offset;
    }
}

void ArrayData::reserve(ArrayData *d, uint n)
{
    if (n < 8)
        n = 8;
    if (n <= d->alloc)
        return;

    d->alloc = qMax(n, 2*d->alloc);
    SafeValue *newArrayData = new SafeValue[d->alloc + d->offset];
    if (d->data) {
        memcpy(newArrayData + d->offset, d->data, sizeof(SafeValue)*d->len);
        delete [] (d->data - d->offset);
    }
    d->data = newArrayData + d->offset;

    if (d->attrs) {
        PropertyAttributes *newAttrs = new PropertyAttributes[d->alloc];
        memcpy(newAttrs, d->attrs, sizeof(PropertyAttributes)*d->len);
        delete [] (d->attrs - d->offset);

        d->attrs = newAttrs;
    }
}

void ArrayData::ensureAttributes()
{
    if (attrs)
        return;

    if (type == Simple)
        type = Complex;
    attrs = new PropertyAttributes[alloc + offset];
    attrs += offset;
    for (uint i = 0; i < len; ++i)
        attrs[i] = Attr_Data;
}


void ArrayData::freeData(ArrayData *d)
{
    delete [] (d->data - d->offset);
    if (d->attrs)
        delete [] (d->attrs - d->offset);
    delete d;
}

ReturnedValue ArrayData::get(const ArrayData *d, uint index)
{
    if (index >= d->len)
        return Primitive::emptyValue().asReturnedValue();
    return d->data[index].asReturnedValue();
}

bool ArrayData::put(ArrayData *d, uint index, ValueRef value)
{
    Q_ASSERT(index >= d->len || !d->attrs || !d->attrs[index].isAccessor());
    // ### honour attributes
    d->data[index] = value;
    if (index >= d->len) {
        if (d->attrs)
            d->attrs[index] = Attr_Data;
        d->len = index;
    }
    return true;
}

bool ArrayData::del(ArrayData *d, uint index)
{
    if (index >= d->len)
        return true;

    if (!d->attrs || d->attrs[index].isConfigurable()) {
        d->data[index] = Primitive::emptyValue();
        if (d->attrs)
            d->attrs[index] = Attr_Data;
        return true;
    }
    if (d->data[index].isEmpty())
        return true;
    return false;
}

void ArrayData::setAttribute(ArrayData *d, uint index, PropertyAttributes attrs)
{
    d->attrs[index] = attrs;
}

PropertyAttributes ArrayData::attribute(const ArrayData *d, uint index)
{
    return d->attrs[index];
}

void ArrayData::push_front(ArrayData *d, SafeValue *values, uint n)
{
    Q_ASSERT(!d->attrs);
    for (int i = n - 1; i >= 0; --i) {
        if (!d->offset)
            ArrayData::getHeadRoom(d);

        --d->offset;
        --d->data;
        ++d->len;
        ++d->alloc;
        *d->data = values[i].asReturnedValue();
    }

}

ReturnedValue ArrayData::pop_front(ArrayData *d)
{
    Q_ASSERT(!d->attrs);
    if (!d->len)
        return Encode::undefined();

    ReturnedValue v = d->data[0].isEmpty() ? Encode::undefined() : d->data[0].asReturnedValue();
    ++d->offset;
    ++d->data;
    --d->len;
    --d->alloc;
    return v;
}

uint ArrayData::truncate(ArrayData *d, uint newLen)
{
    if (d->attrs) {
        SafeValue *it = d->data + d->len;
        const SafeValue *begin = d->data + newLen;
        while (--it >= begin) {
            if (!it->isEmpty() && !d->attrs[it - d->data].isConfigurable()) {
                newLen = it - d->data + 1;
                break;
            }
            *it = Primitive::emptyValue();
        }
    }
    d->len = newLen;
    return newLen;
}

bool ArrayData::putArray(ArrayData *d, uint index, SafeValue *values, uint n)
{
    if (index + n > d->alloc)
        reserve(d, index + n + 1);
    for (uint i = d->len; i < index; ++i)
        d->data[i] = Primitive::emptyValue();
    for (uint i = 0; i < n; ++i)
        d->data[index + i] = values[i];
    d->len = qMax(d->len, index + n);
    return true;
}

void SparseArrayData::free(ArrayData *d, uint idx)
{
    Q_ASSERT(d && d->type == ArrayData::Sparse);
    SparseArrayData *dd = static_cast<SparseArrayData *>(d);
    SafeValue *v = dd->data + idx;
    if (dd->attrs && dd->attrs[idx].isAccessor()) {
        // double slot, free both. Order is important, so we have a double slot for allocation again afterwards.
        v[1].tag = Value::Empty_Type;
        v[1].uint_32 = dd->freeList;
        v[0].tag = Value::Empty_Type;
        v[0].uint_32 = idx + 1;
    } else {
        v->tag = Value::Empty_Type;
        v->uint_32 = dd->freeList;
    }
    dd->freeList = idx;
    if (dd->attrs)
        dd->attrs[idx].clear();
}


void SparseArrayData::freeData(ArrayData *d)
{
    delete static_cast<SparseArrayData *>(d)->sparse;
    ArrayData::freeData(d);
}

void SparseArrayData::reserve(ArrayData *d, uint n)
{
    if (n < 8)
        n = 8;
    if (n <= d->alloc)
        return;

    SparseArrayData *dd = static_cast<SparseArrayData *>(d);
    uint oldAlloc = dd->alloc;
    // ### FIXME
    dd->len = dd->alloc;
    dd->alloc = qMax(n, 2*dd->alloc);
    SafeValue *newArrayData = new SafeValue[dd->alloc];
    if (dd->data) {
        memcpy(newArrayData, dd->data, sizeof(SafeValue)*dd->len);
        delete [] dd->data;
    }
    dd->data = newArrayData;
    if (dd->attrs) {
        PropertyAttributes *newAttrs = new PropertyAttributes[dd->alloc];
        memcpy(newAttrs, dd->attrs, sizeof(PropertyAttributes)*dd->len);
        delete [] dd->attrs;
        dd->attrs = newAttrs;
    }
    for (uint i = oldAlloc; i < dd->alloc; ++i)
        dd->data[i] = Primitive::fromInt32(i + 1);
}

// double slots are required for accessor properties
uint SparseArrayData::allocate(ArrayData *d, bool doubleSlot)
{
    Q_ASSERT(d->type == ArrayData::Sparse);
    SparseArrayData *dd = static_cast<SparseArrayData *>(d);
    if (doubleSlot) {
        uint *last = &dd->freeList;
        while (1) {
            if (*last + 1 >= dd->alloc) {
                reserve(d, d->alloc + 2);
                last = &dd->freeList;
            }

            if (dd->data[*last].uint_32 == (*last + 1)) {
                // found two slots in a row
                uint idx = *last;
                *last = dd->data[*last + 1].uint_32;
                d->attrs[idx] = Attr_Accessor;
                return idx;
            }
            last = &dd->data[*last].uint_32;
        }
    } else {
        if (dd->alloc == dd->freeList)
            reserve(d, d->alloc + 2);
        uint idx = dd->freeList;
        dd->freeList = dd->data[idx].uint_32;
        if (dd->attrs)
            dd->attrs[idx] = Attr_Data;
        return idx;
    }
}

ReturnedValue SparseArrayData::get(const ArrayData *d, uint index)
{
    SparseArrayNode *n = static_cast<const SparseArrayData *>(d)->sparse->findNode(index);
    if (!n)
        return Primitive::emptyValue().asReturnedValue();
    return d->data[n->value].asReturnedValue();
}

bool SparseArrayData::put(ArrayData *d, uint index, ValueRef value)
{
    if (value->isEmpty())
        return true;

    SparseArrayNode *n = static_cast<SparseArrayData *>(d)->sparse->insert(index);
    Q_ASSERT(n->value == UINT_MAX || !d->attrs || !d->attrs[n->value].isAccessor());
    if (n->value == UINT_MAX)
        n->value = allocate(d);
    d->data[n->value] = value;
    if (d->attrs)
        d->attrs[n->value] = Attr_Data;
    return true;
}

bool SparseArrayData::del(ArrayData *d, uint index)
{
    SparseArrayData *dd = static_cast<SparseArrayData *>(d);
    SparseArrayNode *n = dd->sparse->findNode(index);
    if (!n)
        return true;

    uint pidx = n->value;
    Q_ASSERT(!dd->data[pidx].isEmpty());

    bool isAccessor = false;
    if (dd->attrs) {
        if (!dd->attrs[pidx].isConfigurable())
            return false;

        isAccessor = dd->attrs[pidx].isAccessor();
        dd->attrs[pidx] = Attr_Data;
    }

    if (isAccessor) {
        // free up both indices
        d->data[pidx + 1].tag = Value::Undefined_Type;
        d->data[pidx + 1].uint_32 = static_cast<SparseArrayData *>(d)->freeList;
        d->data[pidx].tag = Value::Undefined_Type;
        d->data[pidx].uint_32 = pidx + 1;
    } else {
        d->data[pidx].tag = Value::Undefined_Type;
        d->data[pidx].uint_32 = static_cast<SparseArrayData *>(d)->freeList;
    }

    static_cast<SparseArrayData *>(d)->freeList = pidx;
    static_cast<SparseArrayData *>(d)->sparse->erase(n);
    return true;
}

void SparseArrayData::setAttribute(ArrayData *d, uint index, PropertyAttributes attrs)
{
    SparseArrayNode *n = static_cast<SparseArrayData *>(d)->sparse->insert(index);
    if (n->value == UINT_MAX)
        n->value = allocate(d, attrs.isAccessor());
    else if (attrs.isAccessor() != d->attrs[n->value].isAccessor()) {
        // need to convert the slot
        free(d, n->value);
        n->value = allocate(d, attrs.isAccessor());
    }
    d->attrs[n->value] = attrs;
}

PropertyAttributes SparseArrayData::attribute(const ArrayData *d, uint index)
{
    SparseArrayNode *n = static_cast<const SparseArrayData *>(d)->sparse->insert(index);
    if (!n)
        return PropertyAttributes();
    return d->attrs[n->value];
}

void SparseArrayData::push_front(ArrayData *d, SafeValue *values, uint n)
{
    Q_ASSERT(!d->attrs);
    for (int i = n - 1; i >= 0; --i) {
        uint idx = allocate(d);
        d->data[idx] = values[i];
        static_cast<SparseArrayData *>(d)->sparse->push_front(idx);
    }
}

ReturnedValue SparseArrayData::pop_front(ArrayData *d)
{
    Q_ASSERT(!d->attrs);
    uint idx = static_cast<SparseArrayData *>(d)->sparse->pop_front();
    ReturnedValue v;
    if (idx != UINT_MAX) {
        v = d->data[idx].asReturnedValue();
        SparseArrayData::free(d, idx);
    } else {
        v = Encode::undefined();
    }
    return v;
}

uint SparseArrayData::truncate(ArrayData *d, uint newLen)
{
    SparseArrayNode *begin = static_cast<SparseArrayData *>(d)->sparse->lowerBound(newLen);
    if (begin != static_cast<SparseArrayData *>(d)->sparse->end()) {
        SparseArrayNode *it = static_cast<SparseArrayData *>(d)->sparse->end()->previousNode();
        while (1) {
            if (d->attrs) {
                if (!d->attrs[it->value].isConfigurable()) {
                    newLen = it->key() + 1;
                    break;
                }
            }
            free(d, it->value);
            bool brk = (it == begin);
            SparseArrayNode *prev = it->previousNode();
            static_cast<SparseArrayData *>(d)->sparse->erase(it);
            if (brk)
                break;
            it = prev;
        }
    }
    return newLen;
}

bool SparseArrayData::putArray(ArrayData *d, uint index, SafeValue *values, uint n)
{
    for (uint i = 0; i < n; ++i)
        put(d, index + i, values[i]);
    d->len = qMax(d->len, index + n);
    return true;
}


uint ArrayData::append(Object *o, const ArrayObject *otherObj, uint n)
{
    ArrayData *d = o->arrayData;
    if (!n)
        return o->getLength();

    const ArrayData *other = otherObj->arrayData;

    if (other->isSparse()) {
        o->initSparseArray();
        d = o->arrayData;
    }

    uint oldSize = o->getLength();

    // ### copy attributes as well!
    if (d->type == ArrayData::Sparse) {
        if (other->isSparse()) {
            if (otherObj->hasAccessorProperty && other->hasAttributes()) {
                for (const SparseArrayNode *it = static_cast<const SparseArrayData *>(other)->sparse->begin();
                     it != static_cast<const SparseArrayData *>(other)->sparse->end(); it = it->nextNode())
                    o->arraySet(oldSize + it->key(), *reinterpret_cast<Property *>(other->data + it->value), other->attrs[it->value]);
            } else {
                for (const SparseArrayNode *it = static_cast<const SparseArrayData *>(other)->sparse->begin();
                     it != static_cast<const SparseArrayData *>(other)->sparse->end(); it = it->nextNode())
                    o->arraySet(oldSize + it->key(), other->data[it->value]);
            }
        } else {
            d->put(oldSize, other->data, n);
        }
    } else if (other->length()) {
        d->vtable->reserve(d, oldSize + other->length());
        if (oldSize > d->len) {
            for (uint i = d->len; i < oldSize; ++i)
                d->data[i] = Primitive::emptyValue();
        }
        if (other->attrs) {
            for (uint i = 0; i < other->len; ++i) {
                bool exists;
                d->data[oldSize + i] = const_cast<ArrayObject *>(otherObj)->getIndexed(i, &exists);
                d->len = oldSize + i + 1;
                o->arrayData->setAttributes(oldSize + i, Attr_Data);
                if (!exists)
                    d->data[oldSize + i] = Primitive::emptyValue();
            }
        } else {
            d->len = oldSize + other->len;
            memcpy(d->data + oldSize, other->data, other->len*sizeof(Property));
            if (d->attrs)
                std::fill(d->attrs + oldSize, d->attrs + oldSize + other->len, PropertyAttributes(Attr_Data));
        }
    }

    return oldSize + n;
}

Property *ArrayData::insert(Object *o, uint index, bool isAccessor)
{
    Property *pd;
    if (o->arrayData->type != ArrayData::Sparse && (index < 0x1000 || index < o->arrayData->len + (o->arrayData->len >> 2))) {
        Q_ASSERT(!isAccessor);
        if (index >= o->arrayData->alloc)
            o->arrayReserve(index + 1);
        if (index >= o->arrayData->len) {
            // mark possible hole in the array
            for (uint i = o->arrayData->len; i < index; ++i)
                o->arrayData->data[i] = Primitive::emptyValue();
            o->arrayData->len = index + 1;
        }
        pd = reinterpret_cast<Property *>(o->arrayData->data + index);
    } else {
        o->initSparseArray();
        SparseArrayNode *n = static_cast<SparseArrayData *>(o->arrayData)->sparse->insert(index);
        if (n->value == UINT_MAX)
            n->value = SparseArrayData::allocate(o->arrayData, isAccessor);
        pd = reinterpret_cast<Property *>(o->arrayData->data + n->value);
    }
    return pd;
}

void ArrayData::markObjects(ExecutionEngine *e)
{
    for (uint i = 0; i < len; ++i)
        data[i].mark(e);
}

void ArrayData::sort(ExecutionContext *context, ObjectRef thisObject, const ValueRef comparefn, uint len)
{
    if (!len)
        return;

    ArrayData *d = thisObject->arrayData;
    if (!d || (!d->len && d->type != ArrayData::Sparse))
        return;

    if (!(comparefn->isUndefined() || comparefn->asObject())) {
        context->throwTypeError();
        return;
    }

    // The spec says the sorting goes through a series of get,put and delete operations.
    // this implies that the attributes don't get sorted around.

    if (d->type == ArrayData::Sparse) {
        // since we sort anyway, we can simply iterate over the entries in the sparse
        // array and append them one by one to a regular one.
        SparseArrayData *sparse = static_cast<SparseArrayData *>(d);

        if (!sparse->sparse->nEntries())
            return;

        thisObject->arrayData = new ArrayData;
        d = thisObject->arrayData;
        d->vtable->reserve(d, sparse->sparse->nEntries());

        SparseArrayNode *n = sparse->sparse->begin();
        uint i = 0;
        if (sparse->attrs) {
            d->ensureAttributes();
            while (n != sparse->sparse->end()) {
                if (n->value >= len)
                    break;

                PropertyAttributes a = sparse->attrs ? sparse->attrs[n->value] : Attr_Data;
                d->data[i] = thisObject->getValue(reinterpret_cast<Property *>(sparse->data + n->value), a);
                d->attrs[i] = a.isAccessor() ? Attr_Data : a;

                n = n->nextNode();
                ++i;
            }
        } else {
            while (n != sparse->sparse->end()) {
                if (n->value >= len)
                    break;
                d->data[i] = sparse->data[n->value];
                n = n->nextNode();
                ++i;
            }
        }
        d->len = i;
        if (len > i)
            len = i;
        if (n != sparse->sparse->end()) {
            // have some entries outside the sort range that we need to ignore when sorting
            thisObject->initSparseArray();
            d = thisObject->arrayData;
            while (n != sparse->sparse->end()) {
                PropertyAttributes a = sparse->attrs ? sparse->attrs[n->value] : Attr_Data;
                thisObject->arraySet(n->value, *reinterpret_cast<Property *>(sparse->data + n->value), a);

                n = n->nextNode();
            }

        }

        sparse->ArrayData::free();
    } else {
        if (len > d->len)
            len = d->len;

        // sort empty values to the end
        for (uint i = 0; i < len; i++) {
            if (d->data[i].isEmpty()) {
                while (--len > i)
                    if (!d->data[len].isEmpty())
                        break;
                Q_ASSERT(!d->attrs || !d->attrs[len].isAccessor());
                d->data[i] = d->data[len];
                d->data[len] = Primitive::emptyValue();
            }
        }

        if (!len)
            return;
    }


    ArrayElementLessThan lessThan(context, thisObject, comparefn);

    SafeValue *begin = d->data;
    std::sort(begin, begin + len, lessThan);

#ifdef CHECK_SPARSE_ARRAYS
    thisObject->initSparseArray();
#endif

}