GlobalSettings.h

/***************************************************************************
 *   Copyright (C) 2019-2024 by Stefan Kebekus                             *
 *   stefan.kebekus@gmail.com                                              *
 *                                                                         *
 *   This program is free software; you can redistribute it and/or modify  *
 *   it under the terms of the GNU General Public License as published by  *
 *   the Free Software Foundation; either version 3 of the License, or     *
 *   (at your option) any later version.                                   *
 *                                                                         *
 *   This program 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 General Public License for more details.                          *
 *                                                                         *
 *   You should have received a copy of the GNU General Public License     *
 *   along with this program; if not, write to the                         *
 *   Free Software Foundation, Inc.,                                       *
 *   59 Temple Place - Suite 330, Boston, MA  02111-1307, USA.             *
 ***************************************************************************/
 
#pragma once
 
#include <QProperty>
#include <QQmlEngine>
#include <QSettings>
 
#include "GlobalObject.h"
#include "notification/Notification.h"
#include "units/ByteSize.h"
#include "units/Distance.h"
 

 
class GlobalSettings : public QObject
{
    Q_OBJECT
    QML_ELEMENT
    QML_SINGLETON
 
public:
    //
    // Constructor and destructor
    //

    explicit GlobalSettings(QObject *parent = nullptr);
 
    // No default constructor, important for QML singleton
    explicit GlobalSettings() = delete;
 
    // Standard Destructor
    ~GlobalSettings() override = default;
 
    // factory function for QML singleton
    static GlobalSettings* create(QQmlEngine * /*unused*/, QJSEngine * /*unused*/)
    {
        return GlobalObject::globalSettings();
    }
 
 
    //
    // Properties
    //

    Q_PROPERTY(bool alwaysOpenExternalWebsites READ alwaysOpenExternalWebsites WRITE setAlwaysOpenExternalWebsites NOTIFY alwaysOpenExternalWebsitesChanged)
 
    
    Q_PROPERTY(int acceptedTerms READ acceptedTerms WRITE setAcceptedTerms NOTIFY acceptedTermsChanged)

    Q_PROPERTY(Units::Distance airspaceAltitudeLimit READ airspaceAltitudeLimit WRITE setAirspaceAltitudeLimit NOTIFY airspaceAltitudeLimitChanged)

    Q_PROPERTY(Units::Distance airspaceAltitudeLimit_min MEMBER airspaceAltitudeLimit_min CONSTANT)

    Q_PROPERTY(Units::Distance airspaceAltitudeLimit_max MEMBER airspaceAltitudeLimit_max CONSTANT)

    Q_PROPERTY(bool autoFlightDetection READ autoFlightDetection WRITE setAutoFlightDetection NOTIFY autoFlightDetectionChanged)

    Q_PROPERTY(bool expandNotamAbbreviations READ expandNotamAbbreviations WRITE setExpandNotamAbbreviations NOTIFY expandNotamAbbreviationsChanged)

    Q_PROPERTY(bool flightLogEnabled READ flightLogEnabled CONSTANT)

    Q_PROPERTY(int fontSize READ fontSize WRITE setFontSize NOTIFY fontSizeChanged)

    Q_PROPERTY(bool hideGlidingSectors READ hideGlidingSectors WRITE setHideGlidingSectors NOTIFY hideGlidingSectorsChanged)

    Q_PROPERTY(bool ignoreSSLProblems READ ignoreSSLProblems WRITE setIgnoreSSLProblems NOTIFY ignoreSSLProblemsChanged)

    Q_PROPERTY(Units::Distance lastValidAirspaceAltitudeLimit READ lastValidAirspaceAltitudeLimit NOTIFY lastValidAirspaceAltitudeLimitChanged)

    Q_PROPERTY(Units::ByteSize lastWhatsNewHash READ lastWhatsNewHash WRITE setLastWhatsNewHash NOTIFY lastWhatsNewHashChanged)

    Q_PROPERTY(Units::ByteSize lastWhatsNewInMapsHash READ lastWhatsNewInMapsHash WRITE setLastWhatsNewInMapsHash NOTIFY lastWhatsNewInMapsHashChanged)

    Q_PROPERTY(bool nightMode READ nightMode WRITE setNightMode BINDABLE bindableNightMode NOTIFY nightModeChanged)

    Q_PROPERTY(bool positioningByTrafficDataReceiver READ positioningByTrafficDataReceiver WRITE setPositioningByTrafficDataReceiver BINDABLE bindablePositioningByTrafficDataReceiver)

    Q_PROPERTY(Units::ByteSize privacyHash READ privacyHash WRITE setPrivacyHash NOTIFY privacyHashChanged)

    Q_PROPERTY(bool showAltitudeAGL READ showAltitudeAGL WRITE setShowAltitudeAGL NOTIFY showAltitudeAGLChanged)

    Q_PROPERTY(bool showCurrentFlightTrace READ showCurrentFlightTrace WRITE setShowCurrentFlightTrace NOTIFY showCurrentFlightTraceChanged)

    Q_PROPERTY(bool trackRecording READ trackRecording WRITE setTrackRecording NOTIFY trackRecordingChanged)

    Q_PROPERTY(uint voiceNotifications READ voiceNotifications WRITE setVoiceNotifications NOTIFY voiceNotificationsChanged)
 
 
    //
    // Getter Methods
    //

    [[nodiscard]] auto acceptedTerms() const -> int { return m_settings.value(QStringLiteral("acceptedTerms"), 0).toInt(); }

    [[nodiscard]] bool alwaysOpenExternalWebsites() const { return m_settings.value(QStringLiteral("alwaysOpenExternalWebsites"), false).toBool(); }

    [[nodiscard]] auto airspaceAltitudeLimit() const -> Units::Distance;

    [[nodiscard]] auto autoFlightDetection() const -> bool;

    [[nodiscard]] bool expandNotamAbbreviations() const { return m_settings.value(QStringLiteral("expandNotamAbbreviations"), false).toBool(); }

    [[nodiscard]] auto flightLogEnabled() const -> bool;

    [[nodiscard]] auto fontSize() const -> int;

    [[nodiscard]] auto hideGlidingSectors() const -> bool { return m_settings.value(QStringLiteral("Map/hideGlidingSectors"), true).toBool(); }

    [[nodiscard]] auto ignoreSSLProblems() const -> bool { return m_settings.value(QStringLiteral("ignoreSSLProblems"), false).toBool(); }

    [[nodiscard]] auto lastValidAirspaceAltitudeLimit() const -> Units::Distance;

    [[nodiscard]] auto lastWhatsNewHash() const -> Units::ByteSize
    {
        return m_settings.value(QStringLiteral("lastWhatsNewHash"), 0).value<size_t>();
    }

    [[nodiscard]] auto lastWhatsNewInMapsHash() const -> Units::ByteSize
    {
        return m_settings.value(QStringLiteral("lastWhatsNewInMapsHash"), 0).value<size_t>();
    }

    [[nodiscard]] auto nightMode() const -> bool { return m_nightMode.value(); }

    [[nodiscard]] QBindable<bool> bindableNightMode() { return &m_nightMode; }

    [[nodiscard]] bool positioningByTrafficDataReceiver() const { return m_positioningByTrafficDataReceiver.value(); }

    [[nodiscard]] QBindable<bool> bindablePositioningByTrafficDataReceiver() const { return &m_positioningByTrafficDataReceiver; }

    [[nodiscard]] auto privacyHash() const -> Units::ByteSize  { return m_settings.value(QStringLiteral("privacyHash"), 0).value<size_t>(); }

    [[nodiscard]] auto showAltitudeAGL() const -> bool { return m_settings.value(QStringLiteral("showAltitudeAGL"), false).toBool(); }

    [[nodiscard]] auto showCurrentFlightTrace() const -> bool { return m_settings.value(QStringLiteral("FlightLog/showCurrentFlightTrace"), true).toBool(); }

    [[nodiscard]] auto trackRecording() const -> bool { return m_settings.value(QStringLiteral("FlightLog/trackRecording"), true).toBool(); }

    [[nodiscard]] auto voiceNotifications() const -> uint
    {
        return m_settings.value(QStringLiteral("voiceNotifications"),
                              Notifications::Notification::Info_Navigation |
                                  Notifications::Notification::Warning |
                                  Notifications::Notification::Warning_Navigation |
                                  Notifications::Notification::Alert).toUInt();
    }
 
 
    //
    // Setter Methods
    //

    void setAcceptedTerms(int terms);

    void setAlwaysOpenExternalWebsites(bool alwaysOpen);

    void setAirspaceAltitudeLimit(Units::Distance newAirspaceAltitudeLimit);

    void setAutoFlightDetection(bool newAutoFlightDetection);

    void setExpandNotamAbbreviations(bool newExpandNotamAbbreviations);

    void setHideGlidingSectors(bool hide);

    void setFontSize(int newFontSize);

    void setIgnoreSSLProblems(bool ignore);

    void setLargeFonts(bool newLargeFonts);

    void setLastWhatsNewHash(Units::ByteSize lwnh);

    void setLastWhatsNewInMapsHash(Units::ByteSize lwnh);

    void setNightMode(bool newNightMode);

    void setPositioningByTrafficDataReceiver(bool newPositioningByTrafficDataReceiver);

    void setPrivacyHash(Units::ByteSize newHash);

    void setShowAltitudeAGL(bool newShowAltitudeAGL);

    void setShowCurrentFlightTrace(bool newShowCurrentFlightTrace);

    void setTrackRecording(bool newTrackRecording);

    void setVoiceNotifications(uint newVoiceNotifications);
 
 
    //
    // Constants
    //
 
    static constexpr Units::Distance airspaceAltitudeLimit_min = Units::Distance::fromFT(3000);
    static constexpr Units::Distance airspaceAltitudeLimit_max = Units::Distance::fromFT(15000);
 
signals:
    void acceptedTermsChanged();

    void alwaysOpenExternalWebsitesChanged();

    void airspaceAltitudeLimitChanged();

    void autoFlightDetectionChanged();

    void expandNotamAbbreviationsChanged();

    void fontSizeChanged();

    void hideGlidingSectorsChanged();

    void ignoreSSLProblemsChanged();

    void lastValidAirspaceAltitudeLimitChanged();

    void lastWhatsNewHashChanged();

    void lastWhatsNewInMapsHashChanged();

    void nightModeChanged();

    void privacyHashChanged();

    void showAltitudeAGLChanged();

    void showCurrentFlightTraceChanged();

    void trackRecordingChanged();

    void voiceNotificationsChanged();
 
private:
    Q_DISABLE_COPY_MOVE(GlobalSettings)
 
    QSettings m_settings;
 
    // Property-backed night mode setting, so that C++ bindings can depend on
    // it. Initialized from m_settings, which is declared above on purpose.
    QProperty<bool> m_nightMode {m_settings.value(QStringLiteral("Map/nightMode"), false).toBool()};
 
    QProperty<bool> m_positioningByTrafficDataReceiver;
};