kconfig.h

/*
   This file is part of the KDE libraries
   Copyright (c) 2006, 2007 Thomas Braxton <[email protected]>
   Copyright (c) 2001 Waldo Bastian <[email protected]>
   Copyright (c) 1999 Preston Brown <[email protected]>
   Copyright (c) 1997 Matthias Kalle Dalheimer <[email protected]>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KCONFIG_H
#define KCONFIG_H

#include "kconfigbase.h"

#include <kconfigcore_export.h>

#include <QString>
#include <QVariant>
#include <QByteArray>
#include <QList>
#include <qstandardpaths.h>

class KConfigGroup;
class KEntryMap;
class KConfigPrivate;

class KCONFIGCORE_EXPORT KConfig : public KConfigBase
{
public:
    enum OpenFlag {
        IncludeGlobals  = 0x01, 
        CascadeConfig   = 0x02, 

        SimpleConfig    = 0x00, 
        NoCascade       = IncludeGlobals, 
        NoGlobals       = CascadeConfig, 
        FullConfig      = IncludeGlobals | CascadeConfig 
    };
    Q_DECLARE_FLAGS(OpenFlags, OpenFlag)

    
    explicit KConfig(const QString &file = QString(), OpenFlags mode = FullConfig,
                     QStandardPaths::StandardLocation type = QStandardPaths::GenericConfigLocation);

    KConfig(const QString &file, const QString &backend, QStandardPaths::StandardLocation type = QStandardPaths::GenericConfigLocation);

    virtual ~KConfig();

    QStandardPaths::StandardLocation locationType() const;

    QString name() const;

    OpenFlags openFlags() const;

    bool sync() override;

    bool isDirty() const;

    void markAsClean() override;

    AccessMode accessMode() const override;

    bool isConfigWritable(bool warnUser);

    KConfig *copyTo(const QString &file, KConfig *config = nullptr) const;

    void checkUpdate(const QString &id, const QString &updateFile);

    void reparseConfiguration();


    void addConfigSources(const QStringList &sources);

    QStringList additionalConfigSources() const;


    QString locale() const;
    bool setLocale(const QString &aLocale);


    void setReadDefaults(bool b);
    bool readDefaults() const;

    bool isImmutable() const override;

#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(4, 0)

    KCONFIGCORE_DEPRECATED_VERSION(4, 0, "Not recommended")
    void setForceGlobal(bool force);
#endif

#if KCONFIGCORE_ENABLE_DEPRECATED_SINCE(4, 0)

    KCONFIGCORE_DEPRECATED_VERSION(4, 0, "Not recommended")
    bool forceGlobal() const;
#endif

    QStringList groupList() const override;

    QMap<QString, QString> entryMap(const QString &aGroup = QString()) const;

    static void setMainConfigName(const QString &str);

protected:
    bool hasGroupImpl(const QByteArray &group) const override;
    KConfigGroup groupImpl(const QByteArray &b) override;
    const KConfigGroup groupImpl(const QByteArray &b) const override;
    void deleteGroupImpl(const QByteArray &group, WriteConfigFlags flags = Normal) override;
    bool isGroupImmutableImpl(const QByteArray &aGroup) const override;

    friend class KConfigGroup;
    friend class KConfigGroupPrivate;
    friend class KSharedConfig;

    void virtual_hook(int id, void *data) override;

    KConfigPrivate *const d_ptr;

    KConfig(KConfigPrivate &d);

private:
    friend class KConfigTest;

    QStringList keyList(const QString &aGroup = QString()) const;

    static QString mainConfigName();

    Q_DISABLE_COPY(KConfig)

    Q_DECLARE_PRIVATE(KConfig)
};
Q_DECLARE_OPERATORS_FOR_FLAGS(KConfig::OpenFlags)

#endif // KCONFIG_H