Messenger.hpp

#ifndef H_EXTENSIONS_CUTEHMI_2_INCLUDE_CUTEHMI_MESSENGER_HPP
#define H_EXTENSIONS_CUTEHMI_2_INCLUDE_CUTEHMI_MESSENGER_HPP
 
#include "internal/common.hpp"
#include "Message.hpp"
#include "ExceptionMixin.hpp"
#include "Singleton.hpp"
 
#include <QObject>
#include <QMutexLocker>
#include <QQmlEngine>
 
namespace cutehmi {
 
class CUTEHMI_API Messenger:
    public QObject,
    public Singleton<Messenger>
{
        Q_OBJECT
        //<CuteHMI.Workarounds.Qt5Compatibility-4.workaround target="Qt" cause="Qt5.15-QML_SINGLETON">
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
        QML_NAMED_ELEMENT(Messenger)
        QML_UNCREATABLE("Messenger is a singleton")
        QML_SINGLETON
#endif
        //</CuteHMI.Workarounds.Qt5Compatibility-4.workaround>
 
        friend class Singleton<Messenger>;
 
    public:
        class CUTEHMI_API NoAdvertiserException:
            public ExceptionMixin<NoAdvertiserException>
        {
                typedef ExceptionMixin<NoAdvertiserException> Parent;
 
            public:
                explicit NoAdvertiserException(Message & message);
 
                NoAdvertiserException(const NoAdvertiserException & other);
 
                NoAdvertiserException & operator =(const NoAdvertiserException & other);
 
                const Message * message() const;
 
            private:
                struct Members
                {
                    std::unique_ptr<Message> message;
                };
 
                MPtr<Members> m;
        };
 
        static Messenger * create(QQmlEngine * qmlEngine, QJSEngine * jsEngine);
 
        Q_INVOKABLE void advertise(cutehmi::Message * message_l);
 
        Q_INVOKABLE void resetAdvertiser(QObject * advertiser);
 
    signals:
        void messageRequested(QVariant message);
 
    protected:
        explicit Messenger(QObject * parent = nullptr);
 
        struct Members
        {
            QMutex requestMutex {};
            QObject * advertiser {nullptr};
        };
 
        MPtr<Members> m;
};
 
}
 
#endif
 
//(c)C: Copyright © 2019-2022, Michał Policht <michal@policht.pl>. All rights reserved.
//(c)C: SPDX-License-Identifier: LGPL-3.0-or-later OR MIT
//(c)C: This file is a part of CuteHMI.
//(c)C: CuteHMI is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
//(c)C: CuteHMI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
//(c)C: You should have received a copy of the GNU Lesser General Public License along with CuteHMI.  If not, see <https://www.gnu.org/licenses/>.
//(c)C: Additionally, this file is licensed under terms of MIT license as expressed below.
//(c)C: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//(c)C: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//(c)C: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.