kconfigbase.h

/*
    This file is part of the KDE libraries
    SPDX-FileCopyrightText: 2006, 2007 Thomas Braxton <[email protected]>
    SPDX-FileCopyrightText: 2001 Waldo Bastian <[email protected]>
    SPDX-FileCopyrightText: 1999 Preston Brown <[email protected]>
    SPDX-FileCopyrightText: 1997 Matthias Kalle Dalheimer <[email protected]>
 
    SPDX-License-Identifier: LGPL-2.0-or-later
*/
 
#ifndef KCONFIGBASE_H
#define KCONFIGBASE_H
 
#include <kconfigcore_export.h>
 
#include <QStringList>
#include <QtGlobal>
 
class KConfigGroup;
class KConfigBasePrivate;
 
/**
 * \class KConfigBase kconfigbase.h <KConfigBase>
 * \brief Interface to interact with configuration.
 *
 * KConfigBase allows a component of an application to persists its configuration
 * without the component knowing if it is storing the configuration into a top
 * level KConfig or a KConfigGroup inside a KConfig instance.
 */
class KCONFIGCORE_EXPORT KConfigBase
{
public:
    /**
     * Flags to control write entry
     * @see WriteConfigFlags
     */
    enum WriteConfigFlag {
        Persistent = 0x01,
        /**<
         * Save this entry when saving the config object.
         */
        Global = 0x02,
        /**<
         * Save the entry to the global %KDE config file instead of the
         * application specific config file.
         */
        Localized = 0x04,
        /**<
         * Add the locale tag to the key when writing it.
         */
        Notify = 0x08 | Persistent,
        /**<
         * Notify remote KConfigWatchers of changes (requires DBus support)
         * Implied persistent
         * @since 5.51
         */
        Normal = Persistent,
        /**<
         * Save the entry to the application specific config file without
         * a locale tag. This is the default.
         */
 
    };
    /**
     * Stores a combination of #WriteConfigFlag values.
     */
    Q_DECLARE_FLAGS(WriteConfigFlags, WriteConfigFlag)
 
    /**
     * Destructs the KConfigBase object.
     */
    virtual ~KConfigBase();
 
    /**
     * Returns a list of groups that are known about.
     *
     * @return The list of groups.
     **/
    virtual QStringList groupList() const = 0;
 
    /**
     * Returns true if the specified group is known about.
     *
     * @param group name of group to search for
     * @return true if the group exists.
     */
    bool hasGroup(const QString &group) const;
    /**
     * Overload for hasGroup(const QString&) const
     *
     * @param group name of group to search for, encoded in UTF-8
     */
    bool hasGroup(const char *group) const;
    /**
     * Overload for hasGroup(const QString&) const
     *
     * @param group name of group to search for, encoded in UTF-8
     */
    bool hasGroup(const QByteArray &group) const;
 
    /**
     * Returns an object for the named subgroup.
     *
     * @param group the group to open. Pass an empty string here to the KConfig
     *   object to obtain a handle on the root group.
     * @return config group object for the given group name.
     */
    KConfigGroup group(const QString &group);
    /**
     * Overload for group(const QString&)
     *
     * @param group name of group, encoded in UTF-8
     */
    KConfigGroup group(const QByteArray &group);
    /**
     * Overload for group(const QString&)
     *
     * @param group name of group, encoded in UTF-8
     */
    KConfigGroup group(const char *group);
 
    /**
     * Const overload for group(const QString&)
     */
    const KConfigGroup group(const QString &group) const;
    /**
     * Const overload for group(const QString&)
     *
     * @param group name of group, encoded in UTF-8
     */
    const KConfigGroup group(const QByteArray &group) const;
    /**
     * Const overload for group(const QString&)
     *
     * @param group name of group, encoded in UTF-8
     */
    const KConfigGroup group(const char *group) const;
 
    /**
     * Delete @p group.
     * This marks @p group as @em deleted in the config object. This effectively
     * removes any cascaded values from config files earlier in the stack.
     */
    void deleteGroup(const QString &group, WriteConfigFlags flags = Normal);
    /**
     * Overload for deleteGroup(const QString&, WriteConfigFlags)
     *
     * @param group name of group to delete, encoded in UTF-8
     */
    void deleteGroup(const QByteArray &group, WriteConfigFlags flags = Normal);
    /**
     * Overload for deleteGroup(const QString&, WriteConfigFlags)
     *
     * @param group name of group to delete, encoded in UTF-8
     */
    void deleteGroup(const char *group, WriteConfigFlags flags = Normal);
 
    /**
     * Syncs the configuration object that this group belongs to.
     * Unrelated concurrent changes to the same file are merged and thus
     * not overwritten. Note however, that this object is @em not automatically
     * updated with those changes.
     */
    virtual bool sync() = 0;
 
    /**
     * Reset the dirty flags of all entries in the entry map, so the
     * values will not be written to disk on a later call to sync().
     */
    virtual void markAsClean() = 0;
 
    /**
     * Possible return values for accessMode().
     */
    enum AccessMode {
        NoAccess,
        ReadOnly,
        ReadWrite,
    };
 
    /**
     * Returns the access mode of the app-config object.
     *
     * Possible return values
     * are NoAccess (the application-specific config file could not be
     * opened neither read-write nor read-only), ReadOnly (the
     * application-specific config file is opened read-only, but not
     * read-write) and ReadWrite (the application-specific config
     * file is opened read-write).
     *
     * @return the access mode of the app-config object
     */
    virtual AccessMode accessMode() const = 0;
 
    /**
     * Checks whether this configuration object can be modified.
     * @return whether changes may be made to this configuration object.
     */
    virtual bool isImmutable() const = 0;
 
    /**
     * Can changes be made to the entries in @p group?
     *
     * @param group The group to check for immutability.
     * @return @c false if the entries in @p group can be modified, otherwise @c true
     */
    bool isGroupImmutable(const QString &group) const;
    /**
     * Overload for isGroupImmutable(const QString&) const
     *
     * @param group name of group, encoded in UTF-8
     */
    bool isGroupImmutable(const QByteArray &group) const;
    /**
     * Overload for isGroupImmutable(const QString&) const
     *
     * @param group name of group, encoded in UTF-8
     */
    bool isGroupImmutable(const char *group) const;
 
protected:
    KConfigBase();
 
    /// @param group name of group, encoded in UTF-8
    virtual bool hasGroupImpl(const QByteArray &group) const = 0;
    /// @param group name of group, encoded in UTF-8
    virtual KConfigGroup groupImpl(const QByteArray &group) = 0;
    /// @param group name of group, encoded in UTF-8
    virtual const KConfigGroup groupImpl(const QByteArray &group) const = 0;
    /// @param group name of group, encoded in UTF-8
    virtual void deleteGroupImpl(const QByteArray &group, WriteConfigFlags flags = Normal) = 0;
    /// @param group name of group, encoded in UTF-8
    virtual bool isGroupImmutableImpl(const QByteArray &group) const = 0;
 
    /** Virtual hook, used to add new "virtual" functions while maintaining
     * binary compatibility. Unused in this class.
     */
    virtual void virtual_hook(int id, void *data);
};
 
Q_DECLARE_OPERATORS_FOR_FLAGS(KConfigBase::WriteConfigFlags)
 
#endif // KCONFIG_H