/**
 * UGENE - Integrated Bioinformatics Tools.
 * Copyright (C) 2008-2023 UniPro <ugene@unipro.ru>
 * http://ugene.net
 *
 * 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 2
 * 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., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301, USA.
 */

#pragma once

#include <QStringList>
#include <QVariant>

#include <U2Core/global.h>

namespace U2 {

class U2CORE_EXPORT Settings : public QObject {
    Q_OBJECT
public:
    virtual QStringList getAllKeys(const QString& path) const = 0;
    virtual QStringList getChildGroups(const QString& path) const = 0;
    virtual void cleanSection(const QString& path) = 0;

    virtual bool contains(const QString& key) const = 0;
    virtual void remove(const QString& key) = 0;
    /*
     * Returns value for given key, for versioned and pathed default value is 
     * returned if versions don't match all version-specific values must use versioneedValue = true
     * all path-specific values must use versioneedValue = true and bool pathValue = true
     */
    virtual QVariant getValue(const QString& key, const QVariant& defaultValue = QVariant(), bool versionedValue = false, bool pathValue = false) const = 0;
    virtual void setValue(const QString& key, const QVariant& value, bool versionedValue = false, bool pathValue = false) = 0;

    virtual QString toVersionKey(const QString& key) const = 0;
    virtual QString toMinorVersionKey(const QString& key) const = 0;

    virtual QString toPathKey(const QString& key) const = 0;

    virtual void sync() = 0;
    virtual QString fileName() const = 0;
};

}  // namespace U2
