qv4dateobject_p.h

Go to the documentation of this file.

// 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
// Qt-Security score:significant
#ifndef QV4DATEOBJECT_P_H
#define QV4DATEOBJECT_P_H
 
//
//  W A R N I N G
//  -------------
//
// This file is not part of the Qt API.  It exists purely as an
// implementation detail.  This header file may change from version to
// version without notice, or even be removed.
//
// We mean it.
//
 
#include "qv4object_p.h"
#include "qv4functionobject_p.h"
#include "qv4referenceobject_p.h"
#include <QtCore/private/qnumeric_p.h>
#include <QtCore/qdatetime.h>
 
QT_BEGIN_NAMESPACE
 
class QDateTime;
 
namespace QV4 {
 
struct Date
{
    static constexpr quint64 MaxDateVal = 8.64e15;
 
    void init() { storage = InvalidDateVal; }
    void init(Date date) { storage = date.storage; }
    void init(double value);
    void init(const QDateTime &dateTime);
    void init(QDate date);
    void init(QTime time, ExecutionEngine *engine);
 
    Date &operator=(double value)
    {
        storage = (storage & (HasQDate | HasQTime)) | encode(value);
        return *this;
    }
 
    operator double() const
    {
        const quint64 raw = (storage & ~(HasQDate | HasQTime));
        if (raw == 0)
            return qt_qnan();
 
        if (raw > MaxDateVal)
            return double(raw - MaxDateVal - Extra);
 
        return double(raw) - double(MaxDateVal) - double(Extra);
    }
 
    QDate toQDate() const;
    QTime toQTime() const;
    QDateTime toQDateTime() const;
    QVariant toVariant() const;
 
    template<typename Function>
    bool withReadonlyStoragePointer(Function function)
    {
        switch (storage & (HasQDate | HasQTime)) {
        case HasQDate: {
            QDate date = toQDate();
            return function(&date);
        }
        case HasQTime: {
            QTime time = toQTime();
            return function(&time);
        }
        case (HasQTime | HasQDate): {
            QDateTime dateTime = toQDateTime();
            return function(&dateTime);
        }
        default: {
            double d = operator double();
            return function(&d);
        }
        }
    }
 
    template<typename Function>
    bool withWriteonlyStoragePointer(Function function, ExecutionEngine *engine)
    {
        switch (storage & (HasQDate | HasQTime)) {
        case HasQDate: {
            QDate date;
            if (function(&date)) {
                init(date);
                return true;
            }
            return false;
        }
        case HasQTime: {
            QTime time;
            if (function(&time)) {
                init(time, engine);
                return true;
            }
            return false;
        }
        case (HasQTime | HasQDate): {
            QDateTime dateTime;
            if (function(&dateTime)) {
                init(dateTime);
                return true;
            }
            return false;
        }
        default: {
            double d;
            if (function(&d)) {
                init(d);
                return true;
            }
            return false;
        }
        }
    }
 
private:
    static constexpr quint64 InvalidDateVal = 0;
    static constexpr quint64 Extra = 1;
    static constexpr quint64 HasQDate = 1ull << 63;
    static constexpr quint64 HasQTime = 1ull << 62;
 
    // Make all our dates fit into quint64, leaving space for the flags
    static_assert(((MaxDateVal * 2 + Extra) & (HasQDate | HasQTime)) == 0ull);
 
    static quint64 encode(double value);
    static quint64 encode(const QDateTime &dateTime);
 
    quint64 storage;
};
 
namespace Heap {
 
#define DateObjectMembers(class, Member)
DECLARE_HEAP_OBJECT(DateObject, ReferenceObject) {
    DECLARE_MARKOBJECTS(DateObject);
 
    void doSetLocation()
    {
        if (CppStackFrame *frame = internalClass->engine->currentStackFrame)
            setLocation(frame->v4Function, frame->statementNumber());
    }
 
    void init()
    {
        ReferenceObject::init(nullptr, -1, {});
        m_date.init();
    }
 
    void init(Date date)
    {
        ReferenceObject::init(nullptr, -1, {});
        m_date.init(date);
    }
 
    void init(double dateTime)
    {
        ReferenceObject::init(nullptr, -1, {});
        m_date.init(dateTime);
    }
 
    void init(const QDateTime &dateTime)
    {
        ReferenceObject::init(nullptr, -1, {});
        m_date.init(dateTime);
    }
 
    void init(const QDateTime &dateTime, Heap::Object *parent, int property, Flags flags)
    {
        ReferenceObject::init(parent, property, flags | EnforcesLocation);
        doSetLocation();
        m_date.init(dateTime);
    };
 
    void init(QDate date, Heap::Object *parent, int property, Flags flags)
    {
        ReferenceObject::init(parent, property, flags | EnforcesLocation);
        doSetLocation();
        m_date.init(date);
    };
 
    void init(QTime time, Heap::Object *parent, int property, Flags flags)
    {
        ReferenceObject::init(parent, property, flags | EnforcesLocation);
        doSetLocation();
        m_date.init(time, internalClass->engine);
    };
 
    DateObject *detached() const;
    bool setVariant(const QVariant &variant);
 
    void setDate(double newDate)
    {
        m_date = newDate;
        if (isAttachedToProperty())
            writeBack();
    }
 
    double date() const
    {
        return m_date;
    }
 
    QVariant toVariant() const { return m_date.toVariant(); }
    QDateTime toQDateTime() const { return m_date.toQDateTime(); }
 
    bool readReference()
    {
        if (!object())
            return false;
 
        if (!isDirty())
            return true;
 
        QV4::Scope scope(internalClass->engine);
        QV4::ScopedObject o(scope, object());
 
        if (!isConnected() && QV4::ReferenceObject::shouldConnect(this))
            QV4::ReferenceObject::connect(this);
 
        bool wasRead = false;
        if (isVariant()) {
            QVariant variant;
            void *a[] = { &variant };
            wasRead = o->metacall(QMetaObject::ReadProperty, property(), a)
                        && setVariant(variant);
        } else {
            wasRead = m_date.withWriteonlyStoragePointer([&](void *storagePointer) {
                void *a[] = { storagePointer };
                return o->metacall(QMetaObject::ReadProperty, property(), a);
            }, scope.engine);
        }
 
        setDirty(!isConnected() || !wasRead);
        return wasRead;
    }
 
    bool writeBack(int internalIndex = QV4::ReferenceObject::AllProperties)
    {
        if (!object() || !canWriteBack())
            return false;
 
        QV4::Scope scope(internalClass->engine);
        QV4::ScopedObject o(scope, object());
 
        int flags = 0;
        int status = -1;
        if (isVariant()) {
            QVariant variant = toVariant();
            void *a[] = { &variant, nullptr, &status, &flags, &internalIndex };
            return o->metacall(QMetaObject::WriteProperty, property(), a);
        }
 
        return m_date.withReadonlyStoragePointer([&](void *storagePointer) {
            void *a[] = { storagePointer, nullptr, &status, &flags, &internalIndex };
            return o->metacall(QMetaObject::WriteProperty, property(), a);
        });
    }
 
private:
    Date m_date;
};
 
 
struct DateCtor : FunctionObject {
    void init(QV4::ExecutionEngine *engine);
};
 
}
 
struct DateObject: ReferenceObject {
    V4_OBJECT2(DateObject, ReferenceObject)
    Q_MANAGED_TYPE(DateObject)
    V4_PROTOTYPE(datePrototype)
 
    void setDate(double date) { d()->setDate(date); }
    double date() const { return d()->date(); }
 
    Q_QML_EXPORT QDateTime toQDateTime() const;
    QString toString() const;
 
    static QString dateTimeToString(const QDateTime &dateTime, ExecutionEngine *engine);
    static double dateTimeToNumber(const QDateTime &dateTime);
    static QDate dateTimeToDate(const QDateTime &dateTime);
    static QDateTime stringToDateTime(const QString &string, ExecutionEngine *engine);
    static QDateTime timestampToDateTime(double timestamp, QTimeZone zone = QTimeZone::LocalTime);
    static double componentsToTimestamp(
            double year, double month, double day,
            double hours, double mins, double secs, double ms,
            ExecutionEngine *v4);
};
 
template<>
inline const DateObject *Value::as() const {
    return isManaged() && m()->internalClass->vtable->type == Managed::Type_DateObject ? static_cast<const DateObject *>(this) : nullptr;
}
 
struct DateCtor: FunctionObject
{
    V4_OBJECT2(DateCtor, FunctionObject)
 
    static ReturnedValue virtualCallAsConstructor(const FunctionObject *, const Value *argv, int argc, const Value *);
    static ReturnedValue virtualCall(const FunctionObject *f, const Value *thisObject, const Value *argv, int);
};
 
struct DatePrototype: Object
{
    V4_PROTOTYPE(objectPrototype)
 
    void init(ExecutionEngine *engine, Object *ctor);
 
    static double getThisDate(ExecutionEngine *v4, const Value *thisObject);
 
    static ReturnedValue method_parse(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_UTC(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_now(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
 
    static ReturnedValue method_toString(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_toDateString(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_toTimeString(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_toLocaleString(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_toLocaleDateString(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_toLocaleTimeString(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_valueOf(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getTime(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getYear(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getFullYear(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getUTCFullYear(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getMonth(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getUTCMonth(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getDate(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getUTCDate(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getDay(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getUTCDay(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getHours(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getUTCHours(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getMinutes(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getUTCMinutes(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getSeconds(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getUTCSeconds(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getMilliseconds(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getUTCMilliseconds(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_getTimezoneOffset(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setTime(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setMilliseconds(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setUTCMilliseconds(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setSeconds(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setUTCSeconds(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setMinutes(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setUTCMinutes(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setHours(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setUTCHours(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setDate(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setUTCDate(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setMonth(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setUTCMonth(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setYear(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setFullYear(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_setUTCFullYear(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_toUTCString(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_toISOString(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_toJSON(const FunctionObject *, const Value *thisObject, const Value *argv, int argc);
    static ReturnedValue method_symbolToPrimitive(const FunctionObject *f, const Value *thisObject, const Value *, int);
 
    static void timezoneUpdated(ExecutionEngine *e);
};
 
template<>
inline bool ReferenceObject::readReference<Heap::DateObject>(Heap::DateObject *ref)
{
    return ref->readReference();
}
 
template<>
inline bool ReferenceObject::writeBack<Heap::DateObject>(Heap::DateObject *ref, int internalIndex)
{
    return ref->writeBack(internalIndex);
}
 
}
 
QT_END_NAMESPACE
 
#endif // QV4ECMAOBJECTS_P_H