qgssettingsentry.h

Go to the documentation of this file.

/***************************************************************************
  qgssettingsentry.h
  --------------------------------------
  Date                 : February 2021
  Copyright            : (C) 2021 by Damiano Lombardi
  Email                : damiano at opengis dot ch
 ***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
 
#ifndef QGSSETTINGSENTRY_H
#define QGSSETTINGSENTRY_H
 
#include <limits>
 
#include "qgis.h"
#include "qgis_core.h"
#include "qgis_sip.h"
 
#include <QColor>
#include <QHash>
#include <QSettings>
#include <QString>
 
using namespace Qt::StringLiterals;
 
class QgsSettingsTreeNode;
 
 
static const inline QMetaEnum sSettingsTypeMetaEnum = QMetaEnum::fromType<Qgis::SettingsType>() SIP_SKIP;
 

class CORE_EXPORT QgsSettingsEntryBase
{
#ifdef SIP_RUN
    SIP_CONVERT_TO_SUBCLASS_CODE
    if ( dynamic_cast< QgsSettingsEntryVariant * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryVariant;
    else if ( dynamic_cast< QgsSettingsEntryString * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryString;
    else if ( dynamic_cast< QgsSettingsEntryStringList * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryStringList;
    else if ( dynamic_cast< QgsSettingsEntryVariantMap * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryVariantMap;
    else if ( dynamic_cast< QgsSettingsEntryBool * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryBool;
    else if ( dynamic_cast< QgsSettingsEntryInteger * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryInteger;
    else if ( dynamic_cast< QgsSettingsEntryDouble * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryDouble;
    else if ( dynamic_cast< QgsSettingsEntryColor * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryColor;
    else if ( dynamic_cast< QgsSettingsEntryBase * >( sipCpp ) )
      sipType = sipType_QgsSettingsEntryBase;
    else
      sipType = NULL;
  SIP_END
#endif
 
  public:

    static bool setGlobalSettingsPath( const QString &path );

    static bool hasGlobalDefault( const QString &key ) SIP_SKIP;

    static QVariant globalDefault( const QString &key ) SIP_SKIP;

    static QStringList globalChildGroups( const QString &prefix ) SIP_SKIP;

    static void setupUserSettings( const QString &profilePath ) SIP_SKIP;

    static QSettings &userSettings() SIP_SKIP;

    static QStringList dynamicKeyPartToList( const QString &dynamicKeyPart );

    QgsSettingsEntryBase(
      const QString &key, const QString &section, const QVariant &defaultValue = QVariant(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    )
      : mName( key )
      , mKey( u"%1/%2"_s.arg( section, key ) )
      , mDefaultValue( defaultValue )
      , mDescription( description )
      , mOptions( options )
    {}

    QgsSettingsEntryBase(
      const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue = QVariant(), const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    ) SIP_THROW( QgsSettingsException );
 
    virtual ~QgsSettingsEntryBase();

    virtual QString typeId() const;

    QString name() const { return mName; }

    QString key( const QString &dynamicKeyPart = QString() ) const;

    QString key( const QStringList &dynamicKeyPartList ) const;

    bool keyIsValid( const QString &key ) const;

    QString definitionKey() const;

    bool hasDynamicKey() const;

    Qgis::SettingsOptions options() const { return mOptions; }

    bool exists( const QString &dynamicKeyPart = QString() ) const;

    bool exists( const QStringList &dynamicKeyPartList ) const;

    Qgis::SettingsOrigin origin( const QStringList &dynamicKeyPartList ) const;

    void remove( const QString &dynamicKeyPart = QString() ) const;

    void remove( const QStringList &dynamicKeyPartList ) const;

    Q_DECL_DEPRECATED int section() const;

    bool setVariantValue( const QVariant &value, const QString &dynamicKeyPart = QString() ) const;

    bool setVariantValue( const QVariant &value, const QStringList &dynamicKeyPartList ) const;

    QVariant valueAsVariant( const QString &dynamicKeyPart = QString() ) const;

    QVariant valueAsVariant( const QStringList &dynamicKeyPartList ) const;

    QVariant valueAsVariantWithDefaultOverride( const QVariant &defaultValueOverride, const QString &dynamicKeyPart = QString() ) const;

    QVariant valueAsVariantWithDefaultOverride( const QVariant &defaultValueOverride, const QStringList &dynamicKeyPartList ) const;

    Q_DECL_DEPRECATED QVariant valueAsVariant( const QString &dynamicKeyPart, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const SIP_DEPRECATED;

    Q_DECL_DEPRECATED QVariant valueAsVariant( const QStringList &dynamicKeyPartList, bool useDefaultValueOverride, const QVariant &defaultValueOverride ) const SIP_DEPRECATED;
 

    QVariant defaultValueAsVariant() const;

    virtual Qgis::SettingsType settingsType() const { return Qgis::SettingsType::Custom; }
    // This cannot be pure virtual otherwise SIP is failing

    QString description() const;

    QVariant formerValueAsVariant( const QString &dynamicKeyPart ) const;

    QVariant formerValueAsVariant( const QStringList &dynamicKeyPartList ) const;

    bool copyValueFromKey( const QString &key, bool removeSettingAtKey = false ) const { return copyValueFromKey( key, {}, removeSettingAtKey ); }

    bool copyValueFromKey( const QString &key, const QStringList &dynamicKeyPartList, bool removeSettingAtKey = false ) const;

    void copyValueToKey( const QString &key, const QStringList &dynamicKeyPartList = QStringList() ) const;

    void copyValueToKeyIfChanged( const QString &key, const QStringList &dynamicKeyPartList = QStringList() ) const;

    QgsSettingsTreeNode *parent() const { return mParentTreeElement; }

    virtual bool checkValueVariant( const QVariant &value ) const
    {
      Q_UNUSED( value )
      return true;
    }

    bool hasChanged() const { return mHasChanged; }
 
  private:
    QVariant valueFromSettingsWithGlobalDefault( const QString &resolvedKey, const QVariant &defaultValue ) const SIP_SKIP;
    QString formerValuekey( const QStringList &dynamicKeyPartList ) const;
 
    QString completeKeyPrivate( const QString &key, const QStringList &dynamicKeyPartList ) const;
 
    static QString sanitizeGlobalKey( const QString &key );
 
    static QHash<QString, QVariant> sGlobalDefaults;
 
    QgsSettingsTreeNode *mParentTreeElement = nullptr;
    QString mName;
    QString mKey;
    QVariant mDefaultValue;
    QString mDescription;
    Qgis::SettingsOptions mOptions;
    mutable bool mHasChanged = false;
};

template<class T> class QgsSettingsEntryBaseTemplate : public QgsSettingsEntryBase
{
  public:
    QgsSettingsEntryBaseTemplate(
      const QString &name, QgsSettingsTreeNode *parent, const QVariant &defaultValue, const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions()
    )
      : QgsSettingsEntryBase( name, parent, defaultValue, description, options )
    {}

    QgsSettingsEntryBaseTemplate( const QString &key, const QString &section, const QVariant &defaultValue, const QString &description = QString(), Qgis::SettingsOptions options = Qgis::SettingsOptions() )
      : QgsSettingsEntryBase( key, section, defaultValue, description, options )
    {}
 
 
    Qgis::SettingsType settingsType() const override = 0;

    T value( const QString &dynamicKeyPart = QString() ) const { return this->convertFromVariant( valueAsVariant( dynamicKeyPart ) ); }

    T value( const QStringList &dynamicKeyPartList ) const { return this->convertFromVariant( valueAsVariant( dynamicKeyPartList ) ); }
 

    inline T valueWithDefaultOverride( const T &defaultValueOverride, const QString &dynamicKeyPart = QString() ) const
    {
      return this->convertFromVariant( valueAsVariantWithDefaultOverride( convertToVariant( defaultValueOverride ), dynamicKeyPart ) );
    }

    inline T valueWithDefaultOverride( const T &defaultValueOverride, const QStringList &dynamicKeyPartList ) const
    {
      return this->convertFromVariant( valueAsVariantWithDefaultOverride( convertToVariant( defaultValueOverride ), dynamicKeyPartList ) );
    }

    bool setValue( const T &value, const QString &dynamicKeyPart = QString() ) const { return setValuePrivate( value, dynamicKeyPartToList( dynamicKeyPart ) ); }

    bool setValue( const T &value, const QStringList &dynamicKeyPartList ) const { return setValuePrivate( value, dynamicKeyPartList ); }

    T defaultValue() const { return convertFromVariant( defaultValueAsVariant() ); }

    T formerValue( const QString &dynamicKeyPart = QString() ) const { return convertFromVariant( formerValueAsVariant( dynamicKeyPart ) ); }

    T formerValue( const QStringList &dynamicKeyPartList ) const { return convertFromVariant( formerValueAsVariant( dynamicKeyPartList ) ); }
 
    bool checkValueVariant( const QVariant &value ) const override { return checkValuePrivate( convertFromVariant( value ) ); }

    virtual T convertFromVariant( const QVariant &value ) const = 0;
 
  protected:
    virtual bool setValuePrivate( const T &value, const QStringList &dynamicKeyPartList ) const
    {
      if ( checkValuePrivate( value ) )
        return QgsSettingsEntryBase::setVariantValue( convertToVariant( value ), dynamicKeyPartList );
      else
        return false;
    }

    virtual QVariant convertToVariant( const T &value ) const { return QVariant::fromValue( value ); }

    virtual bool checkValuePrivate( const T &value ) const
    {
      Q_UNUSED( value )
      return true;
    }
};
 
 
#endif // QGSSETTINGSENTRY_H