ApplicationSettings.h

/*
 * Copyright 2016-2025 Dmitry Ivanov
 *
 * This file is part of libquentier
 *
 * libquentier 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, version 3 of the License.
 *
 * libquentier 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.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with libquentier. If not, see <http://www.gnu.org/licenses/>.
 */

#pragma once

#include <quentier/types/Account.h>

#include <QSettings>

#include <string_view>

namespace quentier::utility {

class QUENTIER_EXPORT ApplicationSettings :
    public QSettings,
    public utility::Printable
{
    Q_OBJECT
public:
    explicit ApplicationSettings(const QString & settingsName = {});

    explicit ApplicationSettings(
        const Account & account, const QString & settingsName = {});

    ApplicationSettings(
        const Account & account, const char * settingsName,
        int settingsNameSize = -1);

    ApplicationSettings(const Account & account, std::string_view settingsName);

    ~ApplicationSettings() override;

    struct ArrayCloser
    {
        ArrayCloser(ApplicationSettings & settings) : m_settings(settings) {}

        ~ArrayCloser()
        {
            m_settings.endArray();
            m_settings.sync();
        }

        ApplicationSettings & m_settings;
    };

    struct GroupCloser
    {
        GroupCloser(ApplicationSettings & settings) : m_settings(settings) {}

        ~GroupCloser()
        {
            m_settings.endGroup();
            m_settings.sync();
        }

        ApplicationSettings & m_settings;
    };

    void beginGroup(const QString & prefix);

    void beginGroup(const char * prefix, int size = -1);

    void beginGroup(std::string_view prefix);

    [[nodiscard]] int beginReadArray(const QString & prefix);

    [[nodiscard]] int beginReadArray(const char * prefix, int size = -1);

    [[nodiscard]] int beginReadArray(std::string_view prefix);

    void beginWriteArray(const QString & prefix, int arraySize = -1);

    void beginWriteArray(
        const char * prefix, int arraySize = -1, int prefixSize = -1);

    void beginWriteArray(std::string_view prefix, int arraySize = -1);

    [[nodiscard]] bool contains(const QString & key) const;

    [[nodiscard]] bool contains(const char * key, int size = -1) const;

    [[nodiscard]] bool contains(std::string_view key) const;

    void remove(const QString & key);

    void remove(const char * key, int size = -1);

    void remove(std::string_view key);

    void setValue(const QString & key, const QVariant & value);

    void setValue(const char * key, const QVariant & value, int keySize = -1);

    void setValue(std::string_view key, const QVariant & value);

    [[nodiscard]] QVariant value(
        const QString & key, const QVariant & defaultValue = {}) const;

    [[nodiscard]] QVariant value(
        const char * key, const QVariant & defaultValue = {},
        int keySize = -1) const;

    [[nodiscard]] QVariant value(
        std::string_view key, const QVariant & defaultValue = {}) const;

    // utility::Printable
    QTextStream & print(QTextStream & strm) const override;

private:
    Q_DISABLE_COPY(ApplicationSettings)
};

} // namespace quentier::utility