ScriptObjectV8Proxy.h

//
//  ScriptObjectV8Proxy.h
//  libraries/script-engine/src/v8
//
//  Created by Heather Anderson on 12/5/21.
//  Modified for V8 by dr Karol Suprynowicz on 2022/10/08
//  Copyright 2021 Vircadia contributors.
//  Copyright 2022-2023 Overte e.V.
//
//  Distributed under the Apache License, Version 2.0.
//  See the accompanying file LICENSE or http://www.apache.org/licenses/LICENSE-2.0.html
//  SPDX-License-Identifier: Apache-2.0
//
 
 
#ifndef hifi_ScriptObjectV8Proxy_h
#define hifi_ScriptObjectV8Proxy_h
 
#include <QtCore/QHash>
#include <QtCore/QList>
#include <QtCore/QPointer>
#include <QtCore/QString>
 
#include "ScriptEngineDebugFlags.h"
#include "../ScriptEngine.h"
#include "../Scriptable.h"
#include "ScriptEngineV8.h"
#include "V8Types.h"
 
#include <shared/ReadWriteLockable.h>
 
class ScriptEngineV8;
class ScriptSignalV8Proxy;
 
// V8TODO: Current implementation relies on weak handle callbacks for destroying objects on C++ side
// this is fine for avoiding memory leaks while script engine runs, but there's no guarantee that these will be called
// when script engine shuts down, so memory leaks may happen
// To avoid this handle visitor needs to be added (it's a feature of V8)
 
class ScriptObjectV8Proxy final {
private:  // implementation
    class PropertyDef {
    public:
        PropertyDef(QString string, uint id) : name(string), _id(id) {};
        QString name;
        ScriptValue::PropertyFlags flags;
        uint _id;
    };
    class MethodDef {
    public:
        MethodDef(QString string, uint id) : name(string), _id(id) {};
        QString name;
        int numMaxParams;
        QList<QMetaMethod> methods;
        uint _id;
    };
    class SignalDef {
    public:
        SignalDef(QString string, uint id) : name(string), _id(id) {};
        QString name;
        QMetaMethod signal;
        uint _id;
    };
    using PropertyDefMap = QHash<uint, PropertyDef>;
    using MethodDefMap = QHash<uint, MethodDef>;
    using SignalDefMap = QHash<uint, SignalDef>;
    using InstanceMap = QHash<uint, QPointer<ScriptSignalV8Proxy> >;
    using PropertyNameMap = QHash<QString, PropertyDef*>;
    using MethodNameMap = QHash<QString, MethodDef*>;
    using SignalNameMap = QHash<QString, SignalDef*>;
 
    static constexpr uint PROPERTY_TYPE = 0x1000;
    static constexpr uint METHOD_TYPE = 0x2000;
    static constexpr uint SIGNAL_TYPE = 0x3000;
    static constexpr uint TYPE_MASK = 0xF000;
 
public:  // construction
    ScriptObjectV8Proxy(ScriptEngineV8* engine, QObject* object, bool ownsObject, const ScriptEngine::QObjectWrapOptions& options);
    virtual ~ScriptObjectV8Proxy();
 
    static V8ScriptValue newQObject(ScriptEngineV8* engine,
                                   QObject* object,
                                   ScriptEngine::ValueOwnership ownership = ScriptEngine::QtOwnership,
                                   const ScriptEngine::QObjectWrapOptions& options = ScriptEngine::QObjectWrapOptions());
    static ScriptObjectV8Proxy* unwrapProxy(const V8ScriptValue& val);
    static ScriptObjectV8Proxy* unwrapProxy(v8::Isolate* isolate, v8::Local<v8::Value>& value);
    static QObject* unwrap(const V8ScriptValue& val);
    inline QObject* toQObject() const { return _object; }
    inline v8::Local<v8::Object> toV8Value() const {
        v8::EscapableHandleScope handleScope(_engine->getIsolate());
        return handleScope.Escape(_v8Object.Get(_engine->getIsolate()));
    }
 
public:
    enum QueryFlag
    {
        HandlesReadAccess = 0x00000001,
        HandlesWriteAccess = 0x00000002,
    };
    Q_DECLARE_FLAGS(QueryFlags, QueryFlag);
 
    virtual QString name() const;
 
    virtual V8ScriptValue property(const V8ScriptValue& object, const V8ScriptString& name, uint id);
    virtual ScriptValue::PropertyFlags propertyFlags(const V8ScriptValue& object, const V8ScriptString& name, uint id);
    virtual QueryFlags queryProperty(const V8ScriptValue& object, const V8ScriptString& name, QueryFlags flags, uint* id);
    virtual void setProperty(V8ScriptValue& object, const V8ScriptString& name, uint id, const V8ScriptValue& value);
    v8::Local<v8::Array> getPropertyNames();
    static void v8Get(v8::Local<v8::Name> name, const v8::PropertyCallbackInfo<v8::Value>& info);
    static void v8Set(v8::Local<v8::Name> name, v8::Local<v8::Value> value_obj, const v8::PropertyCallbackInfo<v8::Value>& info);
    static void v8GetPropertyNames(const v8::PropertyCallbackInfo<v8::Array>& info);
 
private:  // implementation
    void investigate();
    // This gets called when script-owned object is being garbage-collected
    static void weakHandleCallback(const v8::WeakCallbackInfo<ScriptObjectV8Proxy> &info);
 
private:  // storage
    ScriptEngineV8* _engine;
    const ScriptEngine::QObjectWrapOptions _wrapOptions;
    PropertyDefMap _props;
    MethodDefMap _methods;
    SignalDefMap _signals;
    // These are used for property lookups from V8 callbacks
    PropertyNameMap _propNameMap;
    MethodNameMap _methodNameMap;
    SignalNameMap _signalNameMap;
    InstanceMap _signalInstances;
    const bool _ownsObject;
    QPointer<QObject> _object;
    // Handle for its own object
    v8::Persistent<v8::Object> _v8Object;
    bool _wasDestroyed{false};
 
    Q_DISABLE_COPY(ScriptObjectV8Proxy)
};
 
 // V8TODO: there may be memory leaks in these, it's worth checking if the proxy actually gets garbage-collected and destroyed
class ScriptVariantV8Proxy final {
public:  // construction
    ScriptVariantV8Proxy(ScriptEngineV8* engine, const QVariant& variant, V8ScriptValue scriptProto, ScriptObjectV8Proxy* proto);
    ~ScriptVariantV8Proxy();
 
    static V8ScriptValue newVariant(ScriptEngineV8* engine, const QVariant& variant, V8ScriptValue proto);
    static ScriptVariantV8Proxy* unwrapProxy(const V8ScriptValue& val);
    static ScriptVariantV8Proxy* unwrapProxy(v8::Isolate* isolate, v8::Local<v8::Value> &value);
    static QVariant* unwrapQVariantPointer(v8::Isolate* isolate, const v8::Local<v8::Value> &value);
    static QVariant unwrap(const V8ScriptValue& val);
    inline QVariant toQVariant() const { return _variant; }
    inline v8::Local<v8::Object> toV8Value() const {
        v8::EscapableHandleScope handleScope(_engine->getIsolate());
        return handleScope.Escape(_v8Object.Get(_engine->getIsolate()));
    }
 
public:  // QScriptClass implementation
    virtual QString name() const { return _name; }
 
    virtual V8ScriptValue prototype() const { return _scriptProto; }
 
    virtual V8ScriptValue property(const V8ScriptValue& object, const V8ScriptString& name, uint id) {
        return _proto->property(object, name, id);
    }
    virtual ScriptValue::PropertyFlags propertyFlags(const V8ScriptValue& object, const V8ScriptString& name, uint id) {
        return _proto->propertyFlags(object, name, id);
    }
    virtual void setProperty(V8ScriptValue& object, const V8ScriptString& name, uint id, const V8ScriptValue& value) {
        return _proto->setProperty(object, name, id, value);
    }
    static void v8Get(v8::Local<v8::Name> name, const v8::PropertyCallbackInfo<v8::Value>& info);
    static void v8Set(v8::Local<v8::Name> name, v8::Local<v8::Value> value_obj, const v8::PropertyCallbackInfo<v8::Value>& info);
    static void v8GetPropertyNames(const v8::PropertyCallbackInfo<v8::Array>& info);
 
private:
    ScriptEngineV8* _engine;
    QVariant _variant;
    V8ScriptValue _scriptProto;
    ScriptObjectV8Proxy* _proto;
    QString _name;
    v8::UniquePersistent<v8::Object> _v8Object;
 
    Q_DISABLE_COPY(ScriptVariantV8Proxy)
};
 
class ScriptMethodV8Proxy final : public QObject {
    Q_OBJECT
public:  // construction
    ScriptMethodV8Proxy(ScriptEngineV8* engine, QObject* object, V8ScriptValue lifetime,
                               const QList<QMetaMethod>& metas, int numMaxParams);
    virtual ~ScriptMethodV8Proxy();
 
public:  // QScriptClass implementation
    virtual QString name() const { return fullName(); }
    static void callback(const v8::FunctionCallbackInfo<v8::Value>& arguments);
    void call(const v8::FunctionCallbackInfo<v8::Value>& arguments);
    static V8ScriptValue newMethod(ScriptEngineV8* engine, QObject* object, V8ScriptValue lifetime,
                               const QList<QMetaMethod>& metas, int numMaxParams);
 
private:
    static void weakHandleCallback(const v8::WeakCallbackInfo<ScriptMethodV8Proxy> &info);
    QString fullName() const;
 
private:  // storage
    const int _numMaxParams;
    ScriptEngineV8* _engine;
    QPointer<QObject> _object;
    v8::Persistent<v8::Value> _objectLifetime;
    //V8ScriptValue _objectLifetime;
    const QList<QMetaMethod> _metas;
 
    Q_DISABLE_COPY(ScriptMethodV8Proxy)
};
 
// This abstract base class serves solely to declare the Q_INVOKABLE methods for ScriptSignalV8Proxy
// as we're overriding qt_metacall later for the signal callback yet still want to support
// metacalls for the connect/disconnect API
class ScriptSignalV8ProxyBase : public QObject, protected Scriptable {
    Q_OBJECT
public:  // API
    // arg1 was had Null default value, but that needs isolate pointer in V8
    Q_INVOKABLE virtual void connect(ScriptValue arg0, ScriptValue arg1 = ScriptValue()) = 0;
    Q_INVOKABLE virtual void disconnect(ScriptValue arg0, ScriptValue arg1 = ScriptValue()) = 0;
};
 
class ScriptSignalV8Proxy final : public ScriptSignalV8ProxyBase, public ReadWriteLockable {
private:  // storage
    class Connection {
    public:
        V8ScriptValue thisValue;
        V8ScriptValue callback;
        Connection(const V8ScriptValue &v8ThisValue, const V8ScriptValue &v8Callback) : 
            thisValue(v8ThisValue), callback(v8Callback) {};
    };
    using ConnectionList = QList<Connection>;
 
public:  // construction
    inline ScriptSignalV8Proxy(ScriptEngineV8* engine, QObject* object, V8ScriptValue lifetime, const QMetaMethod& meta);
 
    ~ScriptSignalV8Proxy();
 
private:  // implementation
    virtual int qt_metacall(QMetaObject::Call call, int id, void** arguments) override;
    int discoverMetaCallIdx();
    ConnectionList::iterator findConnection(V8ScriptValue thisObject, V8ScriptValue callback);
    //QString fullName() const;
    static void weakHandleCallback(const v8::WeakCallbackInfo<ScriptSignalV8Proxy> &info);
 
public:  // API
    // arg1 was had Null default value, but that needs isolate pointer to create Null in V8
    virtual void connect(ScriptValue arg0, ScriptValue arg1 = ScriptValue()) override;
    virtual void disconnect(ScriptValue arg0, ScriptValue arg1 = ScriptValue()) override;
    //Moved to public temporarily for debugging:
    QString fullName() const;
 
    // Disconnects all signals from the proxy
    void disconnectAll();
 
    // This should be called only just before destruction of ScriptSignalV8Proxy
    void disconnectAllScriptSignalProxies();
 
private:  // storage
 
    ScriptEngineV8* _engine;
    QPointer<QObject> _object;
    v8::Persistent<v8::Value> _objectLifetime;
 
    const QMetaMethod _meta;
    const int _metaCallId;
    ConnectionList _connections;
    bool _isConnected{ false };
 
    // This allows skipping qobject check during disconnect, which is needed during cleanup because qobject is already deleted
    bool _cleanup{ false };
    // Context in which it was created
    v8::UniquePersistent<v8::Context> _v8Context;
    // Call counter for debugging purposes. It can be used to determine which signals are overwhelming script engine.
    int _callCounter{0};
    float _totalCallTime_s{ 0.0 };
#ifdef OVERTE_SCRIPT_USE_AFTER_DELETE_GUARD
    std::atomic<bool> _wasDeleted{false};
#endif
 
    Q_DISABLE_COPY(ScriptSignalV8Proxy)
};
 
#endif  // hifi_ScriptObjectV8Proxy_h