/**************************************************************************** ** ** Copyright (C) 2017 Ford Motor Company ** Contact: https://www.qt.io/licensing/ ** ** This file is part of the QtRemoteObjects 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 The Qt Company. For licensing terms ** and conditions see https://www.qt.io/terms-conditions. For further ** information use the contact form at https://www.qt.io/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 3 as published by the Free Software ** Foundation and appearing in the file LICENSE.LGPL3 included in the ** packaging of this file. Please review the following information to ** ensure the GNU Lesser General Public License version 3 requirements ** will be met: https://www.gnu.org/licenses/lgpl-3.0.html. ** ** GNU General Public License Usage ** Alternatively, this file may be used under the terms of the GNU ** General Public License version 2.0 or (at your option) the GNU General ** Public license version 3 or any later version approved by the KDE Free ** Qt Foundation. The licenses are as published by the Free Software ** Foundation and appearing in the file LICENSE.GPL2 and LICENSE.GPL3 ** included in the packaging of this file. Please review the following ** information to ensure the GNU General Public License requirements will ** be met: https://www.gnu.org/licenses/gpl-2.0.html and ** https://www.gnu.org/licenses/gpl-3.0.html. ** ** $QT_END_LICENSE$ ** ****************************************************************************/ #include "qremoteobjectdynamicreplica.h" #include "qremoteobjectreplica_p.h" #include QT_BEGIN_NAMESPACE /*! \class QRemoteObjectDynamicReplica \inmodule QtRemoteObjects \brief A dynamically instantiated \l {Replica}. There are generated replicas (replicas having the header files produced by the \l {repc} {Replica Compiler}), and dynamic replicas, which are generated on-the-fly. This is the class for the dynamic type of replica. When the connection to the \l {Source} object is made, the initialization step passes the current property values (see \l {Replica Initialization}). In a DynamicReplica, the property/signal/slot details are also sent, allowing the replica object to be created on-the-fly. This can be conventient in QML or scripting, but has two primary disadvantages. First, the object is in effect "empty" until it is successfully initialized by the \l {Source}. Second, in C++, calls must be made using QMetaObject::invokeMethod(), as the moc generated lookup will not be available. This class does not have a public constructor. It can only be instantiated by using the dynamic QRemoteObjectNode::acquire method. */ QRemoteObjectDynamicReplica::QRemoteObjectDynamicReplica() : QRemoteObjectReplica() { } QRemoteObjectDynamicReplica::QRemoteObjectDynamicReplica(QRemoteObjectNode *node, const QString &name) : QRemoteObjectReplica(ConstructWithNode) { initializeNode(node, name); } /*! Destroys the dynamic replica. \sa {Replica Ownership} */ QRemoteObjectDynamicReplica::~QRemoteObjectDynamicReplica() { } /*! \internal Returns a pointer to the dynamically generated meta-object of this object, or QRemoteObjectDynamicReplica's metaObject if the object is not initialized. This function overrides the QObject::metaObject() virtual function to provide the same functionality for dynamic replicas. \sa QObject::metaObject(), {Replica Initialization} */ const QMetaObject* QRemoteObjectDynamicReplica::metaObject() const { auto impl = qSharedPointerCast(d_impl); // Returning nullptr will likely result in a crash if this type is used before the // definition is received. Note: QRemoteObjectDynamicReplica doesn't include the // QObject macro, so it's metaobject would resolve to QRemoteObjectReplica::metaObject() // if we weren't overriding it. if (!impl->m_metaObject) { qWarning() << "Dynamic metaobject is not assigned, returning generic Replica metaObject."; qWarning() << "This may cause issues if used for more than checking the Replica state."; return QRemoteObjectReplica::metaObject(); } return impl->m_metaObject; } /*! \internal This function overrides the QObject::qt_metacast() virtual function to provide the same functionality for dynamic replicas. \sa QObject::qt_metacast() */ void *QRemoteObjectDynamicReplica::qt_metacast(const char *name) { if (!name) return 0; if (!strcmp(name, "QRemoteObjectDynamicReplica")) return static_cast(const_cast(this)); // not entirely sure that one is needed... TODO: check auto impl = qSharedPointerCast(d_impl); if (QString::fromLatin1(name) == impl->m_objectName) return static_cast(const_cast(this)); return QObject::qt_metacast(name); } /*! \internal This function overrides the QObject::qt_metacall() virtual function to provide the same functionality for dynamic replicas. \sa QObject::qt_metacall() */ int QRemoteObjectDynamicReplica::qt_metacall(QMetaObject::Call call, int id, void **argv) { static const bool debugArgs = qEnvironmentVariableIsSet("QT_REMOTEOBJECT_DEBUG_ARGUMENTS"); auto impl = qSharedPointerCast(d_impl); int saved_id = id; id = QRemoteObjectReplica::qt_metacall(call, id, argv); if (id < 0 || impl->m_metaObject == nullptr) return id; if (call == QMetaObject::ReadProperty || call == QMetaObject::WriteProperty) { QMetaProperty mp = metaObject()->property(saved_id); int &status = *reinterpret_cast(argv[2]); if (call == QMetaObject::WriteProperty) { QVariantList args; if (mp.userType() == QMetaType::QVariant) args << *reinterpret_cast(argv[0]); else args << QVariant(mp.userType(), argv[0]); QRemoteObjectReplica::send(QMetaObject::WriteProperty, saved_id, args); } else { if (mp.userType() == QMetaType::QVariant) *reinterpret_cast(argv[0]) = impl->m_propertyStorage[id]; else { const QVariant value = propAsVariant(id); QMetaType::destruct(mp.userType(), argv[0]); QMetaType::construct(mp.userType(), argv[0], value.data()); } const bool readStatus = true; // Caller supports QVariant returns? Then we can also report errors // by storing an invalid variant. if (!readStatus && argv[1]) { status = 0; reinterpret_cast(argv[1])->clear(); } } id = -1; } else if (call == QMetaObject::InvokeMetaMethod) { if (id < impl->m_numSignals) { qCDebug(QT_REMOTEOBJECT) << "DynamicReplica Activate" << impl->m_metaObject->method(saved_id).methodSignature(); // signal relay from Source world to Replica QMetaObject::activate(this, impl->m_metaObject, id, argv); } else { // method relay from Replica to Source const QMetaMethod mm = impl->m_metaObject->method(saved_id); const QList types = mm.parameterTypes(); const int typeSize = types.size(); QVariantList args; args.reserve(typeSize); for (int i = 0; i < typeSize; ++i) { const int type = QMetaType::type(types[i].constData()); if (impl->m_metaObject->indexOfEnumerator(types[i].constData()) != -1) { const auto size = QMetaType(type).sizeOf(); switch (size) { case 1: args.push_back(QVariant(QMetaType::Char, argv[i + 1])); break; case 2: args.push_back(QVariant(QMetaType::Short, argv[i + 1])); break; case 4: args.push_back(QVariant(QMetaType::Int, argv[i + 1])); break; // Qt currently only supports enum values of 4 or less bytes (QMetaEnum value(index) returns int) // case 8: args.push_back(QVariant(QMetaType::Int, argv[i + 1])); break; default: qWarning() << "Invalid enum detected (Dynamic Replica)" << QMetaType::typeName(type) << "with size" << size; args.push_back(QVariant(QMetaType::Int, argv[i + 1])); break; } } else args.push_back(QVariant(type, argv[i + 1])); } if (debugArgs) { qCDebug(QT_REMOTEOBJECT) << "method" << mm.methodSignature() << "invoked - args:" << args; } else { qCDebug(QT_REMOTEOBJECT) << "method" << mm.methodSignature() << "invoked"; } if (mm.returnType() == QMetaType::Void) QRemoteObjectReplica::send(QMetaObject::InvokeMetaMethod, saved_id, args); else { QRemoteObjectPendingCall call = QRemoteObjectReplica::sendWithReply(QMetaObject::InvokeMetaMethod, saved_id, args); if (argv[0]) *(static_cast(argv[0])) = call; } } id = -1; } return id; } QT_END_NAMESPACE