diff options
Diffstat (limited to 'sources/pyside6/libpyside/globalreceiverv2.h')
| -rw-r--r-- | sources/pyside6/libpyside/globalreceiverv2.h | 181 |
1 files changed, 64 insertions, 117 deletions
diff --git a/sources/pyside6/libpyside/globalreceiverv2.h b/sources/pyside6/libpyside/globalreceiverv2.h index da01e6d33..0e3bc562a 100644 --- a/sources/pyside6/libpyside/globalreceiverv2.h +++ b/sources/pyside6/libpyside/globalreceiverv2.h @@ -1,41 +1,5 @@ -/**************************************************************************** -** -** Copyright (C) 2016 The Qt Company Ltd. -** Contact: https://www.qt.io/licensing/ -** -** This file is part of Qt for Python. -** -** $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$ -** -****************************************************************************/ +// 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 #ifndef GLOBALRECEIVER_V2_H #define GLOBALRECEIVER_V2_H @@ -44,10 +8,16 @@ #include "dynamicqmetaobject.h" +#include <QtCore/QtCompare> #include <QtCore/QByteArray> +#include <QtCore/QHashFunctions> #include <QtCore/QObject> +#include <QtCore/QPointer> #include <QtCore/QMap> -#include <QtCore/QSharedPointer> + +#include <memory> + +QT_FORWARD_DECLARE_CLASS(QDebug); namespace PySide { @@ -59,110 +29,87 @@ struct GlobalReceiverKey { const PyObject *object; const PyObject *method; -}; - -inline bool operator==(const GlobalReceiverKey &k1, const GlobalReceiverKey &k2) -{ - return k1.object == k2.object && k1.method == k2.method; -} - -inline bool operator!=(const GlobalReceiverKey &k1, const GlobalReceiverKey &k2) -{ - return k1.object != k2.object || k1.method != k2.method; -} - -size_t qHash(const GlobalReceiverKey &k, size_t seed = 0); - -using GlobalReceiverV2Map = QHash<GlobalReceiverKey, GlobalReceiverV2 *>; -using GlobalReceiverV2MapPtr = QSharedPointer<GlobalReceiverV2Map>; -/** - * A class used to make the link between the C++ Signal/Slot and Python callback - * This class is used internally by SignalManager - **/ + friend constexpr size_t qHash(GlobalReceiverKey k, size_t seed = 0) noexcept + { + return qHashMulti(seed, k.object, k.method); + } + friend constexpr bool comparesEqual(const GlobalReceiverKey &lhs, + const GlobalReceiverKey &rhs) noexcept + { + return lhs.object == rhs.object && lhs.method == rhs.method; + } + Q_DECLARE_EQUALITY_COMPARABLE_LITERAL_TYPE(GlobalReceiverKey) +}; +/// A class used to link C++ Signals to non C++ slots (Python callbacks) by +/// providing fake slots for QObject::connect(). +/// It keeps a Python callback and the list of QObject senders. It is stored +/// in SignalManager by a hash of the Python callback. class GlobalReceiverV2 : public QObject { public: - /** - * Create a GlobalReceiver object that will call 'callback' argumentent - * - * @param callback A Python callable object (can be a method or not) - * @param ma A SharedPointer used on Signal manager that contains all instaces of GlobalReceiver - **/ - GlobalReceiverV2(PyObject *callback, GlobalReceiverV2MapPtr map); - - /** - * Destructor - **/ + Q_DISABLE_COPY_MOVE(GlobalReceiverV2) + + /// Create a GlobalReceiver object that will call 'callback' + /// @param callback A Python callable object (can be a method or not) + explicit GlobalReceiverV2(PyObject *callback, QObject *receiver = nullptr); + ~GlobalReceiverV2() override; - /** - * Reimplemented function from QObject - **/ + /// Reimplemented function from QObject int qt_metacall(QMetaObject::Call call, int id, void **args) override; const QMetaObject *metaObject() const override; - /** - * Add a extra slot to this object - * - * @param signature The signature of the slot to be added - * @return The index of this slot on metaobject - **/ + /// Add a extra slot to this object + /// @param signature The signature of the slot to be added + /// @return The index of this slot on metaobject int addSlot(const char *signature); - /** - * Notify to GlobalReceiver about when a new connection was made - **/ + /// Notify to GlobalReceiver about when a new connection was made void notify(); - /** - * Used to increment the reference of the GlobalReceiver object - * - * @param link This is a optional paramenter used to link the ref to some QObject life - **/ - void incRef(const QObject *link = nullptr); - - /** - * Used to decrement the reference of the GlobalReceiver object - * - * @param link This is a optional paramenter used to dismiss the link ref to some QObject - **/ - void decRef(const QObject *link = nullptr); - - /* - * Return the count of refs which the GlobalReceiver has - * - * @param link If any QObject was passed, the function return the number of references relative to this 'link' object - * @return The number of references - **/ - int refCount(const QObject *link) const; - - /** - * Use to retrieve the unique hash of this GlobalReceiver object - * - * @return a string with a unique id based on GlobalReceiver contents - **/ + /// Used to increment the reference of the GlobalReceiver object + /// @param link This is a parameter used to link the ref to + /// some QObject life. + void incRef(const QObject *link); + + /// Used to decrement the reference of the GlobalReceiver object. + /// @param link This is a parameter used to dismiss the link + /// ref to some QObject. + void decRef(const QObject *link); + + /// Returns whether any senders are registered. + bool isEmpty() const; + + /// Use to retrieve the unique hash of this GlobalReceiver object + /// @return hash key GlobalReceiverKey key() const; - /** - * Use to retrieve the unique hash of the PyObject based on GlobalReceiver rules - * - * @param callback The Python callable object used to calculate the id - * @return a string with a unique id based on GlobalReceiver contents - **/ + /// Use to retrieve the unique hash of the PyObject based on GlobalReceiver rules + /// @param callback The Python callable object used to calculate the id + /// @return hash key static GlobalReceiverKey key(PyObject *callback); const MetaObjectBuilder &metaObjectBuilder() const { return m_metaObject; } MetaObjectBuilder &metaObjectBuilder() { return m_metaObject; } + static const char *senderDynamicProperty; + + void formatDebug(QDebug &debug) const; + private: + void purgeDeletedSenders(); + MetaObjectBuilder m_metaObject; DynamicSlotDataV2 *m_data; - QList<const QObject *> m_refs; - GlobalReceiverV2MapPtr m_sharedMap; + using QObjectPointer = QPointer<const QObject>; + QList<QObjectPointer> m_refs; + QPointer<QObject> m_receiver; }; +QDebug operator<<(QDebug debug, const GlobalReceiverV2 *g); + } #endif |