qt-everywhere-src-5.15.1/qtbase/src/dbus/qdbusreply.cpp - orbit - Git at Google

 /****************************************************************************
 **
 ** Copyright (C) 2016 The Qt Company Ltd.
 ** Contact: https://www.qt.io/licensing/
 **
 ** This file is part of the QtDBus 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 "qdbusreply.h"
 #include "qdbusmetatype.h"
 #include "qdbusmetatype_p.h"
 #include <QDebug>

 #ifndef QT_NO_DBUS

 QT_BEGIN_NAMESPACE

 /*!
     \class QDBusReply
     \inmodule QtDBus
     \since 4.2

     \brief The QDBusReply class stores the reply for a method call to a remote object.

     A QDBusReply object is a subset of the QDBusMessage object that represents a method call's
     reply. It contains only the first output argument or the error code and is used by
     QDBusInterface-derived classes to allow returning the error code as the function's return
     argument.

     It can be used in the following manner:
     \snippet code/src_qdbus_qdbusreply.cpp 0

     If the remote method call cannot fail, you can skip the error checking:
     \snippet code/src_qdbus_qdbusreply.cpp 1

     However, if it does fail under those conditions, the value returned by QDBusReply<T>::value() is
     a default-constructed value. It may be indistinguishable from a valid return value.

     QDBusReply objects are used for remote calls that have no output
     arguments or return values (i.e., they have a "void" return
     type). Use the isValid() function to test if the reply succeeded.

     \sa QDBusMessage, QDBusInterface
 */

 /*!
     \fn template<typename T> QDBusReply<T>::QDBusReply(const QDBusReply &other)
     \since 5.15

     Constructs a copy of \a other.
 */

 /*!
     \fn template<typename T> QDBusReply<T>::QDBusReply(const QDBusMessage &reply)
     Automatically construct a QDBusReply object from the reply message \a reply, extracting the
     first return value from it if it is a success reply.
 */

 /*!
     \fn template<typename T> QDBusReply<T>::QDBusReply(const QDBusPendingReply<T> &reply)
     Constructs a QDBusReply object from the pending reply message, \a reply.
 */

 /*!
     \fn template <typename T> QDBusReply<T>::QDBusReply(const QDBusPendingCall &pcall)
     Automatically construct a QDBusReply object from the asynchronous
     pending call \a pcall. If the call isn't finished yet, QDBusReply
     will call QDBusPendingCall::waitForFinished(), which is a blocking
     operation.

     If the return types patch, QDBusReply will extract the first
     return argument from the reply.
 */

 /*!
     \fn template <typename T> QDBusReply<T>::QDBusReply(const QDBusError &error)
     Constructs an error reply from the D-Bus error code given by \a error.
 */

 /*!
     \fn template <typename T> QDBusReply<T>::operator=(const QDBusReply &other)
     Makes this object be a copy of the object \a other.
 */

 /*!
     \fn template <typename T> QDBusReply<T>::operator=(const QDBusError &dbusError)
     Sets this object to contain the error code given by \a dbusError. You
     can later access it with error().
 */

 /*!
     \fn template <typename T> QDBusReply<T>::operator=(const QDBusMessage &reply)

     Makes this object contain the \a reply message. If \a reply
     is an error message, this function will
     copy the error code and message into this object

     If \a reply is a standard reply message and contains at least
     one parameter, it will be copied into this object, as long as it
     is of the correct type. If it's not of the same type as this
     QDBusError object, this function will instead set an error code
     indicating a type mismatch.
 */

 /*!
     \fn template <typename T> QDBusReply<T>::operator=(const QDBusPendingCall &pcall)

     Makes this object contain the reply specified by the pending
     asynchronous call \a pcall. If the call is not finished yet, this
     function will call QDBusPendingCall::waitForFinished() to block
     until the reply arrives.

     If \a pcall finishes with an error message, this function will
     copy the error code and message into this object

     If \a pcall finished with a standard reply message and contains at
     least one parameter, it will be copied into this object, as long
     as it is of the correct type. If it's not of the same type as this
     QDBusError object, this function will instead set an error code
     indicating a type mismatch.
 */

 /*!
     \fn template <typename T> bool QDBusReply<T>::isValid() const

     Returns \c true if no error occurred; otherwise, returns \c false.

     \sa error()
 */

 /*!
     \fn template<typename T> const QDBusError& QDBusReply<T>::error() const

     Returns the error code that was returned from the remote function call. If the remote call did
     not return an error (i.e., if it succeeded), then the QDBusError object that is returned will
     not be a valid error code (QDBusError::isValid() will return false).

     \sa isValid()
 */

 /*!
     \fn template <typename T> const QDBusError& QDBusReply<T>::error()
     \overload
 */

 /*!
     \fn template <typename T> QDBusReply<T>::value() const
     Returns the remote function's calls return value. If the remote call returned with an error,
     the return value of this function is undefined and may be undistinguishable from a valid return
     value.

     This function is not available if the remote call returns \c void.
 */

 /*!
     \fn template <typename T> QDBusReply<T>::operator Type() const
     Returns the same as value().

     This function is not available if the remote call returns \c void.
 */

 /*!
     \internal
     Fills in the QDBusReply data \a error and \a data from the reply message \a reply.
 */
 void qDBusReplyFill(const QDBusMessage &reply, QDBusError &error, QVariant &data)
 {
     error = QDBusError(reply);

     if (error.isValid()) {
         data = QVariant();      // clear it
         return;
     }

     if (reply.arguments().count() >= 1 && reply.arguments().at(0).userType() == data.userType()) {
         data = reply.arguments().at(0);
         return;
     }

     const char *expectedSignature = QDBusMetaType::typeToSignature(data.userType());
     const char *receivedType = nullptr;
     QByteArray receivedSignature;

     if (reply.arguments().count() >= 1) {
         if (reply.arguments().at(0).userType() == QDBusMetaTypeId::argument()) {
             // compare signatures instead
             QDBusArgument arg = qvariant_cast<QDBusArgument>(reply.arguments().at(0));
             receivedSignature = arg.currentSignature().toLatin1();
             if (receivedSignature == expectedSignature) {
                 // matched. Demarshall it
                 QDBusMetaType::demarshall(arg, data.userType(), data.data());
                 return;
             }
         } else {
             // not an argument and doesn't match?
             int type = reply.arguments().at(0).userType();
             receivedType = QMetaType::typeName(type);
             receivedSignature = QDBusMetaType::typeToSignature(type);
         }
     }

     // error
     if (receivedSignature.isEmpty())
         receivedSignature = "<empty signature>";
     QString errorMsg;
     if (receivedType) {
         errorMsg = QLatin1String("Unexpected reply signature: got \"%1\" (%4), "
                                          "expected \"%2\" (%3)")
                    .arg(QLatin1String(receivedSignature),
                         QLatin1String(expectedSignature),
                         QLatin1String(data.typeName()),
                         QLatin1String(receivedType));
     } else {
         errorMsg = QLatin1String("Unexpected reply signature: got \"%1\", "
                                          "expected \"%2\" (%3)")
                    .arg(QLatin1String(receivedSignature),
                         QLatin1String(expectedSignature),
                         QLatin1String(data.typeName()));
     }

     error = QDBusError(QDBusError::InvalidSignature, errorMsg);
     data = QVariant();      // clear it
 }

 QT_END_NAMESPACE

 #endif // QT_NO_DBUS
	/****************************************************************************
	**
	** Copyright (C) 2016 The Qt Company Ltd.
	** Contact: https://www.qt.io/licensing/
	**
	** This file is part of the QtDBus 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 "qdbusreply.h"
	#include "qdbusmetatype.h"
	#include "qdbusmetatype_p.h"
	#include <QDebug>

	#ifndef QT_NO_DBUS

	QT_BEGIN_NAMESPACE

	/*!
	\class QDBusReply
	\inmodule QtDBus
	\since 4.2

	\brief The QDBusReply class stores the reply for a method call to a remote object.

	A QDBusReply object is a subset of the QDBusMessage object that represents a method call's
	reply. It contains only the first output argument or the error code and is used by
	QDBusInterface-derived classes to allow returning the error code as the function's return
	argument.

	It can be used in the following manner:
	\snippet code/src_qdbus_qdbusreply.cpp 0

	If the remote method call cannot fail, you can skip the error checking:
	\snippet code/src_qdbus_qdbusreply.cpp 1

	However, if it does fail under those conditions, the value returned by QDBusReply<T>::value() is
	a default-constructed value. It may be indistinguishable from a valid return value.

	QDBusReply objects are used for remote calls that have no output
	arguments or return values (i.e., they have a "void" return
	type). Use the isValid() function to test if the reply succeeded.

	\sa QDBusMessage, QDBusInterface
	*/

	/*!
	\fn template<typename T> QDBusReply<T>::QDBusReply(const QDBusReply &other)
	\since 5.15

	Constructs a copy of \a other.
	*/

	/*!
	\fn template<typename T> QDBusReply<T>::QDBusReply(const QDBusMessage &reply)
	Automatically construct a QDBusReply object from the reply message \a reply, extracting the
	first return value from it if it is a success reply.
	*/

	/*!
	\fn template<typename T> QDBusReply<T>::QDBusReply(const QDBusPendingReply<T> &reply)
	Constructs a QDBusReply object from the pending reply message, \a reply.
	*/

	/*!
	\fn template <typename T> QDBusReply<T>::QDBusReply(const QDBusPendingCall &pcall)
	Automatically construct a QDBusReply object from the asynchronous
	pending call \a pcall. If the call isn't finished yet, QDBusReply
	will call QDBusPendingCall::waitForFinished(), which is a blocking
	operation.

	If the return types patch, QDBusReply will extract the first
	return argument from the reply.
	*/

	/*!
	\fn template <typename T> QDBusReply<T>::QDBusReply(const QDBusError &error)
	Constructs an error reply from the D-Bus error code given by \a error.
	*/

	/*!
	\fn template <typename T> QDBusReply<T>::operator=(const QDBusReply &other)
	Makes this object be a copy of the object \a other.
	*/

	/*!
	\fn template <typename T> QDBusReply<T>::operator=(const QDBusError &dbusError)
	Sets this object to contain the error code given by \a dbusError. You
	can later access it with error().
	*/

	/*!
	\fn template <typename T> QDBusReply<T>::operator=(const QDBusMessage &reply)

	Makes this object contain the \a reply message. If \a reply
	is an error message, this function will
	copy the error code and message into this object

	If \a reply is a standard reply message and contains at least
	one parameter, it will be copied into this object, as long as it
	is of the correct type. If it's not of the same type as this
	QDBusError object, this function will instead set an error code
	indicating a type mismatch.
	*/

	/*!
	\fn template <typename T> QDBusReply<T>::operator=(const QDBusPendingCall &pcall)

	Makes this object contain the reply specified by the pending
	asynchronous call \a pcall. If the call is not finished yet, this
	function will call QDBusPendingCall::waitForFinished() to block
	until the reply arrives.

	If \a pcall finishes with an error message, this function will
	copy the error code and message into this object

	If \a pcall finished with a standard reply message and contains at
	least one parameter, it will be copied into this object, as long
	as it is of the correct type. If it's not of the same type as this
	QDBusError object, this function will instead set an error code
	indicating a type mismatch.
	*/

	/*!
	\fn template <typename T> bool QDBusReply<T>::isValid() const

	Returns \c true if no error occurred; otherwise, returns \c false.

	\sa error()
	*/

	/*!
	\fn template<typename T> const QDBusError& QDBusReply<T>::error() const

	Returns the error code that was returned from the remote function call. If the remote call did
	not return an error (i.e., if it succeeded), then the QDBusError object that is returned will
	not be a valid error code (QDBusError::isValid() will return false).

	\sa isValid()
	*/

	/*!
	\fn template <typename T> const QDBusError& QDBusReply<T>::error()
	\overload
	*/

	/*!
	\fn template <typename T> QDBusReply<T>::value() const
	Returns the remote function's calls return value. If the remote call returned with an error,
	the return value of this function is undefined and may be undistinguishable from a valid return
	value.

	This function is not available if the remote call returns \c void.
	*/

	/*!
	\fn template <typename T> QDBusReply<T>::operator Type() const
	Returns the same as value().

	This function is not available if the remote call returns \c void.
	*/

	/*!
	\internal
	Fills in the QDBusReply data \a error and \a data from the reply message \a reply.
	*/
	void qDBusReplyFill(const QDBusMessage &reply, QDBusError &error, QVariant &data)
	{
	error = QDBusError(reply);

	if (error.isValid()) {
	data = QVariant(); // clear it
	return;
	}

	if (reply.arguments().count() >= 1 && reply.arguments().at(0).userType() == data.userType()) {
	data = reply.arguments().at(0);
	return;
	}

	const char *expectedSignature = QDBusMetaType::typeToSignature(data.userType());
	const char *receivedType = nullptr;
	QByteArray receivedSignature;

	if (reply.arguments().count() >= 1) {
	if (reply.arguments().at(0).userType() == QDBusMetaTypeId::argument()) {
	// compare signatures instead
	QDBusArgument arg = qvariant_cast<QDBusArgument>(reply.arguments().at(0));
	receivedSignature = arg.currentSignature().toLatin1();
	if (receivedSignature == expectedSignature) {
	// matched. Demarshall it
	QDBusMetaType::demarshall(arg, data.userType(), data.data());
	return;
	}
	} else {
	// not an argument and doesn't match?
	int type = reply.arguments().at(0).userType();
	receivedType = QMetaType::typeName(type);
	receivedSignature = QDBusMetaType::typeToSignature(type);
	}
	}

	// error
	if (receivedSignature.isEmpty())
	receivedSignature = "<empty signature>";
	QString errorMsg;
	if (receivedType) {
	errorMsg = QLatin1String("Unexpected reply signature: got \"%1\" (%4), "
	"expected \"%2\" (%3)")
	.arg(QLatin1String(receivedSignature),
	QLatin1String(expectedSignature),
	QLatin1String(data.typeName()),
	QLatin1String(receivedType));
	} else {
	errorMsg = QLatin1String("Unexpected reply signature: got \"%1\", "
	"expected \"%2\" (%3)")
	.arg(QLatin1String(receivedSignature),
	QLatin1String(expectedSignature),
	QLatin1String(data.typeName()));
	}

	error = QDBusError(QDBusError::InvalidSignature, errorMsg);
	data = QVariant(); // clear it
	}

	QT_END_NAMESPACE

	#endif // QT_NO_DBUS