ApplicationSettings.h

/*
 * Copyright 2016-2020 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/>.
 */
 
#ifndef LIB_QUENTIER_UTILITY_APPLICATION_SETTINGS_H
#define LIB_QUENTIER_UTILITY_APPLICATION_SETTINGS_H
 
#include <quentier/types/Account.h>
 
#include <QSettings>
 
namespace quentier {
 
class QUENTIER_EXPORT ApplicationSettings : public QSettings, public Printable
{
    Q_OBJECT
public:
    ApplicationSettings(const QString & settingsName = {});
 
    ApplicationSettings(
        const Account & account, const QString & settingsName = {});
 
    ApplicationSettings(
        const Account & account, const char * settingsName,
        const int settingsNameSize = -1);
 
    virtual ~ApplicationSettings() override;
 
public:
    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;
    };
 
public:
    void beginGroup(const QString & prefix);
 
    void beginGroup(const char * prefix, const int size = -1);
 
    int beginReadArray(const QString & prefix);
 
    int beginReadArray(const char * prefix, const int size = -1);
 
    void beginWriteArray(const QString & prefix, const int arraySize = -1);
 
    void beginWriteArray(
        const char * prefix, const int arraySize = -1,
        const int prefixSize = -1);
 
    bool contains(const QString & key) const;
 
    bool contains(const char * key, const int size = -1) const;
 
    void remove(const QString & key);
 
    void remove(const char * key, const int size = -1);
 
    void setValue(const QString & key, const QVariant & value);
 
    void setValue(
        const char * key, const QVariant & value, const int keySize = -1);
 
    QVariant value(
        const QString & key, const QVariant & defaultValue = {}) const;
 
    QVariant value(
        const char * key, const QVariant & defaultValue = {},
        const int keySize = -1) const;
 
public:
    virtual QTextStream & print(QTextStream & strm) const override;
 
private:
    Q_DISABLE_COPY(ApplicationSettings)
};
 
} // namespace quentier
 
#endif // LIB_QUENTIER_UTILITY_APPLICATION_SETTINGS_H