Profile Class Reference

#include <profile.h>

Collaboration diagram for Profile:

Public Member Functions
QString	location (SpecialFolder folder) const
SettingsPtr	applicationSettings (const QString &name) const
QString	rootPath () const
QString	configurationName () const
QString	profileName () const
QString	toPortablePath (const QString &absolutePath) const
QString	fromPortablePath (const QString &portablePath) const

Static Public Member Functions
static void	initInstance (const QString &rootProfilePath, const QString &configurationName, bool convertPathsToProfileRelative)
static void	freeInstance ()
static const Profile *	instance ()

Private Member Functions
	Profile (const QString &rootProfilePath, const QString &configurationName, bool convertPathsToProfileRelative)
	~Profile ()=default
void	ensureDirectoryExists (SpecialFolder folder) const

Private Attributes
std::unique_ptr< Private::Profile >	m_profileImpl
std::unique_ptr< Private::PathConverter >	m_pathConverterImpl

Static Private Attributes
static Profile *	m_instance = nullptr

Detailed Description

Definition at line 54 of file profile.h.

Constructor & Destructor Documentation

Profile()

Profile::Profile ( const QString &  rootProfilePath, const QString &  configurationName, bool  convertPathsToProfileRelative  )

private

Definition at line 36 of file profile.cpp.

{
    if (rootProfilePath.isEmpty())
        m_profileImpl = std::make_unique<Private::DefaultProfile>(configurationName);
    else
        m_profileImpl = std::make_unique<Private::CustomProfile>(rootProfilePath, configurationName);
 
    ensureDirectoryExists(SpecialFolder::Cache);
    ensureDirectoryExists(SpecialFolder::Config);
    ensureDirectoryExists(SpecialFolder::Data);
 
    if (convertPathsToProfileRelative)
        m_pathConverterImpl = std::make_unique<Private::Converter>(m_profileImpl->basePath());
    else
        m_pathConverterImpl = std::make_unique<Private::NoConvertConverter>();
}

References Cache, Config, configurationName(), Data, ensureDirectoryExists(), m_pathConverterImpl, and m_profileImpl.

Referenced by initInstance().

Here is the call graph for this function:

Here is the caller graph for this function:

~Profile()

Profile::~Profile ( )

privatedefault

Member Function Documentation

applicationSettings()

SettingsPtr Profile::applicationSettings

(

const QString &

name

)

const

Definition at line 109 of file profile.cpp.

{
    return m_profileImpl->applicationSettings(name);
}

References m_profileImpl.

Referenced by anonymous_namespace{settingsstorage.cpp}::TransactionalSettings::deserialize(), Statistics::load(), RSS::Feed::loadArticlesLegacy(), RSS::AutoDownloader::loadRulesLegacy(), Statistics::save(), and anonymous_namespace{settingsstorage.cpp}::TransactionalSettings::serialize().

Here is the caller graph for this function:

configurationName()

QString Profile::configurationName

(

)

const

Definition at line 99 of file profile.cpp.

{
    return m_profileImpl->configurationName();
}

References m_profileImpl.

Referenced by initInstance(), and Profile().

Here is the caller graph for this function:

ensureDirectoryExists()

void Profile::ensureDirectoryExists ( SpecialFolder  folder ) const

private

Definition at line 114 of file profile.cpp.

{
    const QString locationPath = location(folder);
    if (!locationPath.isEmpty() && !QDir().mkpath(locationPath))
        qFatal("Could not create required directory '%s'", qUtf8Printable(locationPath));
}

References location().

Referenced by Profile().

Here is the call graph for this function:

Here is the caller graph for this function:

freeInstance()

void Profile::freeInstance ( )

static

Definition at line 61 of file profile.cpp.

{
    delete m_instance;
    m_instance = nullptr;
}

References m_instance.

Referenced by Application::cleanup().

Here is the caller graph for this function:

fromPortablePath()

QString Profile::fromPortablePath

(

const QString &

portablePath

)

const

Definition at line 126 of file profile.cpp.

{
    return m_pathConverterImpl->fromPortablePath(portablePath);
}

References m_pathConverterImpl.

Referenced by BitTorrent::DBResumeDataStorage::load(), and BitTorrent::BencodeResumeDataStorage::loadTorrentResumeData().

Here is the caller graph for this function:

initInstance()

void Profile::initInstance ( const QString &  rootProfilePath, const QString &  configurationName, bool  convertPathsToProfileRelative  )

static

Definition at line 53 of file profile.cpp.

{
    if (m_instance)
        return;
    m_instance = new Profile(rootProfilePath, configurationName, convertPathsToProfileRelative);
}

References configurationName(), m_instance, and Profile().

Referenced by Application::Application().

Here is the call graph for this function:

Here is the caller graph for this function:

instance()

const Profile * Profile::instance ( )

static

Definition at line 67 of file profile.cpp.

{
    return m_instance;
}

References m_instance.

Referenced by Application::Application(), anonymous_namespace{settingsstorage.cpp}::TransactionalSettings::deserialize(), Statistics::load(), BitTorrent::DBResumeDataStorage::load(), RSS::Feed::loadArticlesLegacy(), RSS::AutoDownloader::loadRulesLegacy(), BitTorrent::BencodeResumeDataStorage::loadTorrentResumeData(), Statistics::save(), anonymous_namespace{settingsstorage.cpp}::TransactionalSettings::serialize(), specialFolderLocation(), BitTorrent::BencodeResumeDataStorage::Worker::store(), and BitTorrent::DBResumeDataStorage::Worker::store().

Here is the caller graph for this function:

location()

QString Profile::location

(

SpecialFolder

folder

)

const

Definition at line 72 of file profile.cpp.

{
    QString result;
    switch (folder)
    {
    case SpecialFolder::Cache:
        result = m_profileImpl->cacheLocation();
        break;
    case SpecialFolder::Config:
        result = m_profileImpl->configLocation();
        break;
    case SpecialFolder::Data:
        result = m_profileImpl->dataLocation();
        break;
    case SpecialFolder::Downloads:
        result = m_profileImpl->downloadLocation();
        break;
    }
 
    return result;
}

References Cache, Config, Data, Downloads, and m_profileImpl.

Referenced by Application::Application(), ensureDirectoryExists(), and specialFolderLocation().

Here is the caller graph for this function:

profileName()

QString Profile::profileName

(

)

const

Returns either default name for configuration file (QCoreApplication::applicationName()) or the value, supplied via parameters

Definition at line 104 of file profile.cpp.

{
    return m_profileImpl->profileName();
}

References m_profileImpl.

rootPath()

QString Profile::rootPath

(

)

const

Definition at line 94 of file profile.cpp.

{
    return m_profileImpl->rootPath();
}

References m_profileImpl.

toPortablePath()

QString Profile::toPortablePath

(

const QString &

absolutePath

)

const

Definition at line 121 of file profile.cpp.

{
    return m_pathConverterImpl->toPortablePath(absolutePath);
}

References m_pathConverterImpl.

Referenced by BitTorrent::BencodeResumeDataStorage::Worker::store(), and BitTorrent::DBResumeDataStorage::Worker::store().

Here is the caller graph for this function:

Member Data Documentation

m_instance

Profile * Profile::m_instance = nullptr

staticprivate

Definition at line 83 of file profile.h.

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

m_pathConverterImpl

std::unique_ptr<Private::PathConverter> Profile::m_pathConverterImpl

private

Definition at line 82 of file profile.h.

Referenced by fromPortablePath(), Profile(), and toPortablePath().

m_profileImpl

std::unique_ptr<Private::Profile> Profile::m_profileImpl

private

Definition at line 81 of file profile.h.

Referenced by applicationSettings(), configurationName(), location(), Profile(), profileName(), and rootPath().

---

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

• src/base/profile.h
• src/base/profile.cpp