/****************************************************************************
**
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
** Contact: http://www.qt-project.org/legal
**
** This file is part of the V4VM 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$
**
****************************************************************************/
#ifndef QMLJS_MANAGED_H
#define QMLJS_MANAGED_H

#include <QtCore/QString>
#include <QtCore/QVector>
#include <QtCore/QDebug>
#include "qv4global_p.h"

QT_BEGIN_NAMESPACE

namespace QQmlJS {
namespace VM {

class MemoryManager;
struct String;
struct Object;
struct ObjectPrototype;
struct ExecutionContext;
struct ScriptFunction;

struct BooleanObject;
struct NumberObject;
struct StringObject;
struct ArrayObject;
struct DateObject;
struct FunctionObject;
struct RegExpObject;
struct ErrorObject;
struct ArgumentsObject;
struct JSONObject;
struct ForeachIteratorObject;
struct Managed;
struct Value;
struct RegExp;

struct ManagedVTable
{
    Value (*call)(Managed *, ExecutionContext *context, const Value &thisObject, Value *args, int argc);
    Value (*construct)(Managed *, ExecutionContext *context, Value *args, int argc);
    void (*markObjects)(Managed *);
    void (*destroy)(Managed *);
    bool (*hasInstance)(Managed *, ExecutionContext *ctx, const Value &value);
    Value (*get)(Managed *, ExecutionContext *ctx, String *name, bool *hasProperty);
    Value (*getIndexed)(Managed *, ExecutionContext *ctx, uint index, bool *hasProperty);
    void (*put)(Managed *, ExecutionContext *ctx, String *name, const Value &value);
    void (*putIndexed)(Managed *, ExecutionContext *ctx, uint index, const Value &value);
    PropertyAttributes (*query)(Managed *, ExecutionContext *ctx, String *name);
    PropertyAttributes (*queryIndexed)(Managed *, ExecutionContext *ctx, uint index);
    bool (*deleteProperty)(Managed *m, ExecutionContext *ctx, String *name);
    bool (*deleteIndexedProperty)(Managed *m, ExecutionContext *ctx, uint index);
    const char *className;
};

#define DEFINE_MANAGED_VTABLE(classname) \
const ManagedVTable classname::static_vtbl =    \
{                                               \
    call,                                       \
    construct,                                  \
    markObjects,                                \
    destroy,                                    \
    hasInstance,                                \
    get,                                        \
    getIndexed,                                 \
    put,                                        \
    putIndexed,                                 \
    query,                                      \
    queryIndexed,                               \
    deleteProperty,                             \
    deleteIndexedProperty,                      \
    #classname                                  \
}


struct Q_V4_EXPORT Managed
{
private:
    void *operator new(size_t);
    Managed(const Managed &other);
    void operator = (const Managed &other);

protected:
    Managed()
        : vtbl(&static_vtbl), _data(0)
    { inUse = 1; extensible = 1; }

public:
    void *operator new(size_t size, MemoryManager *mm);
    void operator delete(void *ptr);
    void operator delete(void *ptr, MemoryManager *mm);

    inline void mark() {
        if (markBit)
            return;
        markBit = 1;
        if (vtbl->markObjects)
            vtbl->markObjects(this);
    }

    enum Type {
        Type_Invalid,
        Type_String,
        Type_Object,
        Type_ArrayObject,
        Type_FunctionObject,
        Type_BooleanObject,
        Type_NumberObject,
        Type_StringObject,
        Type_DateObject,
        Type_RegExpObject,
        Type_ErrorObject,
        Type_ArgumentsObject,
        Type_JSONObject,
        Type_MathObject,
        Type_ForeachIteratorObject,
        Type_RegExp
    };

    String *asString() { return reinterpret_cast<String *>(this); }
    Object *asObject() { return reinterpret_cast<Object *>(this); }
    ArrayObject *asArrayObject() { return type == Type_ArrayObject ? reinterpret_cast<ArrayObject *>(this) : 0; }
    FunctionObject *asFunctionObject() { return type == Type_FunctionObject ? reinterpret_cast<FunctionObject *>(this) : 0; }
    BooleanObject *asBooleanObject() { return type == Type_BooleanObject ? reinterpret_cast<BooleanObject *>(this) : 0; }
    NumberObject *asNumberObject() { return type == Type_NumberObject ? reinterpret_cast<NumberObject *>(this) : 0; }
    StringObject *asStringObject() { return type == Type_StringObject ? reinterpret_cast<StringObject *>(this) : 0; }
    DateObject *asDateObject() { return type == Type_DateObject ? reinterpret_cast<DateObject *>(this) : 0; }
    RegExpObject *asRegExpObject() { return type == Type_RegExpObject ? reinterpret_cast<RegExpObject *>(this) : 0; }
    ErrorObject *asErrorObject() { return type == Type_ErrorObject ? reinterpret_cast<ErrorObject *>(this) : 0; }
    ArgumentsObject *asArgumentsObject() { return type == Type_ArgumentsObject ? reinterpret_cast<ArgumentsObject *>(this) : 0; }
    JSONObject *asJSONObject() { return type == Type_JSONObject ? reinterpret_cast<JSONObject *>(this) : 0; }
    ForeachIteratorObject *asForeachIteratorObject() { return type == Type_ForeachIteratorObject ? reinterpret_cast<ForeachIteratorObject *>(this) : 0; }
    RegExp *asRegExp() { return type == Type_RegExp ? reinterpret_cast<RegExp *>(this) : 0; }

    bool isArrayObject() const { return type == Type_ArrayObject; }
    bool isStringObject() const { return type == Type_StringObject; }

    QString className() const;

    Managed **nextFreeRef() {
        return reinterpret_cast<Managed **>(this);
    }
    Managed *nextFree() {
        return *reinterpret_cast<Managed **>(this);
    }
    void setNextFree(Managed *m) {
        *reinterpret_cast<Managed **>(this) = m;
    }

    inline bool hasInstance(ExecutionContext *ctx, const Value &v) {
        return vtbl->hasInstance(this, ctx, v);
    }
    Value construct(ExecutionContext *context, Value *args, int argc);
    Value call(ExecutionContext *context, const Value &thisObject, Value *args, int argc);
    Value get(ExecutionContext *ctx, String *name, bool *hasProperty = 0);
    Value getIndexed(ExecutionContext *ctx, uint index, bool *hasProperty = 0);
    void put(ExecutionContext *ctx, String *name, const Value &value)
    { vtbl->put(this, ctx, name, value); }
    void putIndexed(ExecutionContext *ctx, uint index, const Value &value)
    { vtbl->putIndexed(this, ctx, index, value); }
    bool deleteProperty(ExecutionContext *ctx, String *name)
    { return vtbl->deleteProperty(this, ctx, name); }
    bool deleteIndexedProperty(ExecutionContext *ctx, uint index)
    { return vtbl->deleteIndexedProperty(this, ctx, index); }

    static void destroy(Managed *that) { that->_data = 0; }
    static bool hasInstance(Managed *that, ExecutionContext *ctx, const Value &value);
    static Value construct(Managed *, ExecutionContext *context, Value *, int);
    static Value call(Managed *, ExecutionContext *, const Value &, Value *, int);

    uint internalType() const {
        return type;
    }

protected:

    static const ManagedVTable static_vtbl;

    const ManagedVTable *vtbl;

    union {
        uint _data;
        struct {
            uint markBit :  1;
            uint inUse   :  1;
            uint extensible : 1; // used by Object
            uint isNonStrictArgumentsObject : 1;
            uint isBuiltinFunction : 1; // used by FunctionObject
            uint needsActivation : 1; // used by FunctionObject
            uint usesArgumentsObject : 1; // used by FunctionObject
            uint strictMode : 1; // used by FunctionObject
            uint type : 5;
            mutable uint subtype : 3;
            uint externalComparison : 1;
            uint unused : 15;
        };
    };

private:
    friend class MemoryManager;
    friend struct Identifiers;
};

}
}

QT_END_NAMESPACE

#endif