SettingsStorage Class Reference

#include <settingsstorage.h>

Inheritance diagram for SettingsStorage:

Collaboration diagram for SettingsStorage:

Public Slots
bool	save ()

Public Member Functions
template<typename T >
T	loadValue (const QString &key, const T &defaultValue={}) const
template<typename T >
void	storeValue (const QString &key, const T &value)
void	removeValue (const QString &key)
bool	hasKey (const QString &key) const

Static Public Member Functions
static void	initInstance ()
static void	freeInstance ()
static SettingsStorage *	instance ()

Private Member Functions
	SettingsStorage ()
	~SettingsStorage ()
QVariant	loadValueImpl (const QString &key, const QVariant &defaultValue={}) const
void	storeValueImpl (const QString &key, const QVariant &value)

Private Attributes
bool	m_dirty = false
QVariantHash	m_data
QTimer	m_timer
QReadWriteLock	m_lock

Static Private Attributes
static SettingsStorage *	m_instance = nullptr

Detailed Description

Definition at line 47 of file settingsstorage.h.

Constructor & Destructor Documentation

SettingsStorage()

SettingsStorage::SettingsStorage ( )

private

Definition at line 71 of file settingsstorage.cpp.

    : m_data {TransactionalSettings(QLatin1String("qBittorrent")).read()}
{
    m_timer.setSingleShot(true);
    m_timer.setInterval(5 * 1000);
    connect(&m_timer, &QTimer::timeout, this, &SettingsStorage::save);
}

References m_timer, and save().

Referenced by initInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

~SettingsStorage()

SettingsStorage::~SettingsStorage ( )

private

Definition at line 79 of file settingsstorage.cpp.

{
    save();
}

References save().

Here is the call graph for this function:

Member Function Documentation

freeInstance()

void SettingsStorage::freeInstance ( )

static

Definition at line 90 of file settingsstorage.cpp.

{
    delete m_instance;
    m_instance = nullptr;
}

References m_instance.

Referenced by Application::cleanup().

Here is the caller graph for this function:

hasKey()

bool SettingsStorage::hasKey

(

const QString &

key

)

const

Definition at line 149 of file settingsstorage.cpp.

{
    const QReadLocker locker {&m_lock};
    return m_data.contains(key);
}

References m_data, and m_lock.

initInstance()

void SettingsStorage::initInstance ( )

static

Definition at line 84 of file settingsstorage.cpp.

{
    if (!m_instance)
        m_instance = new SettingsStorage;
}

References m_instance, and SettingsStorage().

Referenced by Application::Application().

Here is the call graph for this function:

Here is the caller graph for this function:

instance()

SettingsStorage * SettingsStorage::instance ( )

static

Definition at line 96 of file settingsstorage.cpp.

{
    return m_instance;
}

References m_instance.

Referenced by Preferences::apply(), anonymous_namespace{upgrade.cpp}::exportWebUIHttpsFiles(), handleChangedDefaults(), RSS::Session::loadLegacy(), TorrentFilesWatcher::loadLegacy(), anonymous_namespace{upgrade.cpp}::migrateSettingKeys(), SettingValue< T >::operator=(), RSS::Session::Session(), setCurrentMigrationVersion(), anonymous_namespace{addnewtorrentdialog.cpp}::settings(), anonymous_namespace{preferences.cpp}::setValue(), anonymous_namespace{upgrade.cpp}::upgradeDNSServiceSettings(), anonymous_namespace{upgrade.cpp}::upgradeListenPortSettings(), anonymous_namespace{upgrade.cpp}::upgradeSchedulerDaysSettings(), anonymous_namespace{upgrade.cpp}::upgradeTorrentContentLayout(), and anonymous_namespace{upgrade.cpp}::upgradeTrayIconStyleSettings().

Here is the caller graph for this function:

loadValue()

template<typename T >

T SettingsStorage::loadValue ( const QString &  key, const T &  defaultValue = {}  ) const

inline

Definition at line 59 of file settingsstorage.h.

                                                            {}) const
    {
        if constexpr (std::is_enum_v<T>)
        {
            const auto value = loadValue<QString>(key);
            return Utils::String::toEnum(value, defaultValue);
        }
        else if constexpr (IsQFlags<T>::value)
        {
            const typename T::Int value = loadValue(key, static_cast<typename T::Int>(defaultValue));
            return T {value};
        }
        else if constexpr (std::is_same_v<T, QVariant>)
        {
            // fast path for loading QVariant
            return loadValueImpl(key, defaultValue);
        }
        else
        {
            const QVariant value = loadValueImpl(key);
            // check if retrieved value is convertible to T
            return value.template canConvert<T>() ? value.template value<T>() : defaultValue;
        }
    }

Referenced by anonymous_namespace{upgrade.cpp}::exportWebUIHttpsFiles(), AddNewTorrentDialog::isEnabled(), AddNewTorrentDialog::isTopLevel(), RSS::Session::loadLegacy(), TorrentFilesWatcher::loadLegacy(), AddNewTorrentDialog::populateSavePaths(), AddNewTorrentDialog::savePathHistoryLength(), anonymous_namespace{addnewtorrentdialog.cpp}::updatePathHistory(), and anonymous_namespace{upgrade.cpp}::upgradeTorrentContentLayout().

Here is the caller graph for this function:

loadValueImpl()

QVariant SettingsStorage::loadValueImpl ( const QString &  key, const QVariant &  defaultValue = {}  ) const

private

Definition at line 117 of file settingsstorage.cpp.

{
    const QReadLocker locker(&m_lock);
    return m_data.value(key, defaultValue);
}

References m_data, and m_lock.

removeValue()

void SettingsStorage::removeValue

(

const QString &

key

)

Definition at line 135 of file settingsstorage.cpp.

{
    const QWriteLocker locker(&m_lock);
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
    if (m_data.remove(key))
#else
    if (m_data.remove(key) > 0)
#endif
    {
        m_dirty = true;
        m_timer.start();
    }
}

References m_data, m_dirty, m_lock, and m_timer.

Referenced by TorrentFilesWatcher::loadLegacy().

Here is the caller graph for this function:

save

bool SettingsStorage::save ( )

slot

Definition at line 101 of file settingsstorage.cpp.

{
    const QWriteLocker locker(&m_lock);  // guard for `m_dirty` too
    if (!m_dirty) return true;
 
    const TransactionalSettings settings(QLatin1String("qBittorrent"));
    if (!settings.write(m_data))
    {
        m_timer.start();
        return false;
    }
 
    m_dirty = false;
    return true;
}

References m_data, m_dirty, m_lock, m_timer, and anonymous_namespace{addnewtorrentdialog.cpp}::settings().

Referenced by SettingsStorage(), and ~SettingsStorage().

Here is the call graph for this function:

Here is the caller graph for this function:

storeValue()

template<typename T >

void SettingsStorage::storeValue ( const QString &  key, const T &  value  )

inline

Definition at line 85 of file settingsstorage.h.

    {
        if constexpr (std::is_enum_v<T>)
            storeValueImpl(key, Utils::String::fromEnum(value));
        else if constexpr (IsQFlags<T>::value)
            storeValueImpl(key, static_cast<typename T::Int>(value));
        else
            storeValueImpl(key, value);
    }

References Utils::String::fromEnum(), storeValueImpl(), and anonymous_namespace{preferences.cpp}::value().

Referenced by SettingValue< T >::operator=(), setCurrentMigrationVersion(), AddNewTorrentDialog::setEnabled(), AddNewTorrentDialog::setSavePathHistoryLength(), AddNewTorrentDialog::setTopLevel(), anonymous_namespace{preferences.cpp}::setValue(), and anonymous_namespace{addnewtorrentdialog.cpp}::updatePathHistory().

Here is the call graph for this function:

Here is the caller graph for this function:

storeValueImpl()

void SettingsStorage::storeValueImpl ( const QString &  key, const QVariant &  value  )

private

Definition at line 123 of file settingsstorage.cpp.

{
    const QWriteLocker locker(&m_lock);
    QVariant &currentValue = m_data[key];
    if (currentValue != value)
    {
        m_dirty = true;
        currentValue = value;
        m_timer.start();
    }
}

References m_data, m_dirty, m_lock, m_timer, and anonymous_namespace{preferences.cpp}::value().

Referenced by storeValue().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

m_data

QVariantHash SettingsStorage::m_data

private

Definition at line 108 of file settingsstorage.h.

Referenced by hasKey(), loadValueImpl(), removeValue(), save(), and storeValueImpl().

m_dirty

bool SettingsStorage::m_dirty = false

private

Definition at line 107 of file settingsstorage.h.

Referenced by removeValue(), save(), and storeValueImpl().

m_instance

SettingsStorage * SettingsStorage::m_instance = nullptr

staticprivate

Definition at line 105 of file settingsstorage.h.

Referenced by freeInstance(), initInstance(), and instance().

m_lock

QReadWriteLock SettingsStorage::m_lock

mutableprivate

Definition at line 110 of file settingsstorage.h.

Referenced by hasKey(), loadValueImpl(), removeValue(), save(), and storeValueImpl().

m_timer

QTimer SettingsStorage::m_timer

private

Definition at line 109 of file settingsstorage.h.

Referenced by removeValue(), save(), SettingsStorage(), and storeValueImpl().

---

The documentation for this class was generated from the following files:

• src/base/settingsstorage.h
• src/base/settingsstorage.cpp