context.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: Copyright (C) 2013 swift Project Community / Contributors
// SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
 
 
#ifndef SWIFT_CORE_CONTEXT_CONTEXT_H
#define SWIFT_CORE_CONTEXT_CONTEXT_H
 
#include <QObject>
#include <QString>
#include <QtGlobal>
 
#include "core/corefacade.h"
#include "core/corefacadeconfig.h"
#include "core/swiftcoreexport.h"
#include "misc/logcategories.h"
#include "misc/logmessage.h"
#include "misc/statusmessage.h"
 
namespace swift::misc
{
    class CLogCategoryList;
}
namespace swift::core::context
{
    class IContextApplication;
    class IContextAudio;
    class IContextNetwork;
    class IContextOwnAircraft;
    class IContextSimulator;
 
    class SWIFT_CORE_EXPORT IContext : public QObject
    {
        Q_OBJECT
 
    public:
        ~IContext() override = default;
 
        static const QStringList &getLogCategories();
 
        bool isUsingImplementingObject() const
        {
            return m_mode == CCoreFacadeConfig::Local || m_mode == CCoreFacadeConfig::LocalInDBusServer;
        }
 
        bool isLocalObject() const { return isUsingImplementingObject() || m_mode == CCoreFacadeConfig::NotUsed; }
 
        bool isEmptyObject() const { return m_mode == CCoreFacadeConfig::NotUsed; }
 
        CCoreFacade *getRuntime()
        {
            Q_ASSERT(this->parent());
            return static_cast<CCoreFacade *>(this->parent());
        }
 
        const CCoreFacade *getRuntime() const
        {
            Q_ASSERT(this->parent());
            return static_cast<CCoreFacade *>(this->parent());
        }
 
        CCoreFacadeConfig::ContextMode getMode() const { return this->m_mode; }
 
        qint64 getUniqueId() const { return this->m_contextId; }
 
        // ---------------------------------------------------------------
        // cross context access
        // ---------------------------------------------------------------
 
        const IContextApplication *getIContextApplication() const;
 
        IContextApplication *getIContextApplication();
 
        IContextAudio *getIContextAudio();
 
        const IContextAudio *getIContextAudio() const;
 
        IContextNetwork *getIContextNetwork();
 
        const IContextNetwork *getIContextNetwork() const;
 
        IContextOwnAircraft *getIContextOwnAircraft();
 
        const IContextOwnAircraft *getIContextOwnAircraft() const;
 
        const IContextSimulator *getIContextSimulator() const;
 
        IContextSimulator *getIContextSimulator();
 
        void setDebugEnabled(bool debug);
 
        bool isDebugEnabled() const;
 
        // ---------------------------------------------------------------
        // All context must implement those functions
        // ---------------------------------------------------------------
 
        virtual QString getPathAndContextId() const = 0;
 
        virtual bool parseCommandLine(const QString &commandLine, const swift::misc::CIdentifier &originator) = 0;
 
    signals:
        void changedLogOrDebugSettings();
 
    protected:
        IContext(CCoreFacadeConfig::ContextMode mode, QObject *parent);
 
        QString buildPathAndContextId(const QString &path) const
        {
            return path % u':' % QString::number(this->getUniqueId());
        }
 
        void relayBaseClassSignals(const QString &serviceName, QDBusConnection &connection, const QString &objectPath,
                                   const QString &interfaceName);
 
        void logEmptyContextWarning(const QString &functionName) const
        {
            misc::CLogMessage(this, swift::misc::CLogCategories::contextSlot())
                    .warning(u"Empty context called, details: %1")
                << functionName;
        }
 
        virtual void onAboutToShutdown() {}
 
        void registerWithDBus(const QString &objectPath, misc::CDBusServer *server);
 
        static const misc::CStatusMessage &statusMessageEmptyContext();
 
    private:
        CCoreFacadeConfig::ContextMode m_mode; 
        qint64 m_contextId; 
        bool m_debugEnabled = false; 
    };
} // namespace swift::core::context
#endif // SWIFT_CORE_CONTEXT_CONTEXT_H