pilotclient/src/blackcore/context_settings.h

/* Copyright (C) 2013 VATSIM Community / authors
 * This Source Code Form is subject to the terms of the Mozilla Public
 * License, v. 2.0. If a copy of the MPL was not distributed with this
 * file, You can obtain one at http://mozilla.org/MPL/2.0/. */

//! \file

#ifndef BLACKCORE_CONTEXTSETTINGS_H
#define BLACKCORE_CONTEXTSETTINGS_H

#include "blackcore/context.h"
#include "blackcore/dbus_server.h"
#include "blackinput/keyboard.h"
#include "blackmisc/setkeyboardhotkeylist.h"
#include "blackmisc/statusmessagelist.h"
#include "blackmisc/dbus.h"
#include "blackmisc/variant.h"
#include "blackcore/settingsallclasses.h"
#include <QObject>
#include <QVariant>

//! \addtogroup dbus
//! @{

//! DBus interface for context
#define BLACKCORE_CONTEXTSETTINGS_INTERFACENAME "net.vatsim.PilotClient.BlackCore.ContextSettings"

//! DBus object path for context
#define BLACKCORE_CONTEXTSETTINGS_OBJECTPATH "/Settings"

//! @}

namespace BlackCore
{
    /*!
     * Context settings interface
     */
    class IContextSettings : public CContext
    {
        Q_OBJECT
        Q_CLASSINFO("D-Bus Interface", BLACKCORE_CONTEXTSETTINGS_INTERFACENAME)

    public:
        //! Settings type
        enum SettingsType
        {
            SettingsHotKeys,
            SettingsNetwork,
            SettingsAudio,
            SettingsSimulator
        };

    protected:
        //! DBus version constructor
        IContextSettings(CRuntimeConfig::ContextMode mode, CRuntime *runtime = nullptr) : CContext(mode, runtime)
        {}

    public:

        //! Service name
        static const QString &InterfaceName()
        {
            static QString s(BLACKCORE_CONTEXTSETTINGS_INTERFACENAME);
            return s;
        }

        //! Service path
        static const QString &ObjectPath()
        {
            static QString s(BLACKCORE_CONTEXTSETTINGS_OBJECTPATH);
            return s;
        }

        //! \copydoc CContext::getPathAndContextId()
        virtual QString getPathAndContextId() const { return this->buildPathAndContextId(ObjectPath()); }

        /*!
         * \brief Path for network settings
         * \remarks no to be confused with DBus paths
         */
        static const QString &PathNetworkSettings()
        {
            static QString s("network");
            return s;
        }

        //! Path for audio settings
        static const QString &PathAudioSettings()
        {
            static QString s("audio");
            return s;
        }

        //! Path for simulator settings
        static const QString &PathSimulatorSettings()
        {
            static QString s("simulator");
            return s;
        }

        //! Root path
        static const QString &PathRoot()
        {
            static QString s("root");
            return s;
        }

        //! Path for hotkeys
        static const QString &PathHotkeys()
        {
            static QString s("hotkeys");
            return s;
        }

        //! Factory method
        static IContextSettings *create(CRuntime *parent, CRuntimeConfig::ContextMode mode, CDBusServer *server, QDBusConnection &conn);

        //! Destructor
        virtual ~IContextSettings() {}

    signals:
        //! Settings have been changed
        void changedSettings(uint type);

    public slots:

        /*!
         * Handle value
         * \param path      where value belongs to
         * \param command   what to do with value
         * \param value
         * \return          messages generated during handling
         */
        virtual BlackMisc::CStatusMessageList value(const QString &path, const QString &command, const BlackMisc::CVariant &value) = 0;

        //! Network settings
        virtual BlackMisc::Settings::CSettingsNetwork getNetworkSettings() const = 0;

        //! Audio settings
        virtual BlackMisc::Settings::CSettingsAudio getAudioSettings() const = 0;

        //! Audio settings
        virtual BlackSim::Settings::CSettingsSimulator getSimulatorSettings() const = 0;

        //! Hotkeys
        virtual BlackMisc::Settings::CSettingKeyboardHotkeyList getHotkeys() const = 0;

        //! Save settings
        virtual BlackMisc::CStatusMessage write() const = 0;

        //! Read settings
        virtual BlackMisc::CStatusMessage read() = 0;

        //! Reset settings
        virtual BlackMisc::CStatusMessage reset(bool write = true) = 0;

        //! Read settings
        virtual QString getSettingsFileName() const = 0;

        //! Settings as JSON string
        virtual QString getSettingsAsJsonString() const = 0;
    };
}

#endif // guard