Compare commits

...

4 Commits

4 changed files with 305 additions and 271 deletions

@ -1 +1 @@
Subproject commit 8fbf0a3b3d8ef4598fe5c334067e2de321e04dae Subproject commit 5e600ab490fc789667062e998bb48effb9bf35a0

View File

@ -18,17 +18,14 @@ int main( int argc, char** argv )
QCoreApplication::setApplicationName( QStringLiteral( CMLIB_PROJECT_NAME ) ); QCoreApplication::setApplicationName( QStringLiteral( CMLIB_PROJECT_NAME ) );
MF::Paths& paths = MF::Paths::instance(); MF::Paths& paths = MF::Paths::instance();
paths.init( QStringLiteral( CMLIB_PROJECT_NAME ), QStringLiteral( "conf" ) ); paths.init();
qDebug() << "prefixDirectory : " << paths.prefixDirectory(); qDebug() << "prefixDirectory : " << paths.projectDirectory();
qDebug() << "executableName : " << paths.executableName(); qDebug() << "executableName : " << paths.executableName();
qDebug() << "executableFilePath : " << paths.executableFilePath(); qDebug() << "executableFilePath : " << paths.executableFilePath();
qDebug() << "executableDirectory : " << paths.executableDirectory(); qDebug() << "executableDirectory : " << paths.executableDirectory();
qDebug() << "configFileName : " << paths.configFileName();
qDebug() << "configFilePath : " << paths.configFilePath();
qDebug() << "systemConfigDirectory : " << paths.systemConfigDirectory(); qDebug() << "systemConfigDirectory : " << paths.systemConfigDirectory();
qDebug() << "systemConstDataDirectory : " << paths.systemConstDataDirectory(); qDebug() << "systemConstDataDirectory : " << paths.systemConstDataDirectory();
qDebug() << "systemVarDataDirectory : " << paths.systemVarDataDirectory(); qDebug() << "systemVarDataDirectory : " << paths.systemVarDataDirectory();

View File

@ -13,7 +13,9 @@ namespace myx {
namespace filesystem { namespace filesystem {
MYXLIB_INLINE Paths::Paths() MYXLIB_INLINE Paths::Paths() :
m_binDirRegex ( "/s*bin$" ),
m_unityBinDirRegex( "/bin/unity$" )
{ {
QFileInfo procSelfExe( QStringLiteral( "/proc/self/exe" ) ); QFileInfo procSelfExe( QStringLiteral( "/proc/self/exe" ) );
QFileInfo currentExecutable = procSelfExe.canonicalFilePath(); QFileInfo currentExecutable = procSelfExe.canonicalFilePath();
@ -23,20 +25,49 @@ MYXLIB_INLINE Paths::Paths()
} }
MYXLIB_INLINE void Paths::setupSystemDirectories( const QString& defaultPrefixDirectory, MYXLIB_INLINE bool Paths::init( bool autodetect )
{
m_autodetect = autodetect;
m_homeDirectory = QDir::homePath();
m_tempDirectory = QDir::tempPath();
m_configDirectory = QString::fromLocal8Bit( qgetenv( "XDG_CONFIG_HOME" ) );
if ( m_configDirectory.isEmpty() )
{
m_configDirectory = m_homeDirectory + "/.config";
}
m_dataDirectory = QString::fromLocal8Bit( qgetenv( "XDG_DATA_HOME" ) );
if ( m_dataDirectory.isEmpty() )
{
m_dataDirectory = m_homeDirectory + "/.local/share";
}
if ( m_projectName.isEmpty() )
{
m_projectName = m_executableName;
}
m_hierarchyType = getHierarchyType();
calculatePaths( m_hierarchyType );
return( true );
} // Paths::init
MYXLIB_INLINE void Paths::setupSystemDirectories( const QString& defaultProjectDirectory,
const QString& defaultEtcDirectory, const QString& defaultEtcDirectory,
const QString& defaultConstDataDirectory, const QString& defaultConstDataDirectory,
const QString& defaultVarDataDirectory, const QString& defaultVarDataDirectory,
const QString& defaultLogDirectory ) const QString& defaultLogDirectory )
{ {
QFileInfo prefixDirInfo { defaultPrefixDirectory }; QFileInfo prefixDirInfo { defaultProjectDirectory };
if ( prefixDirInfo.isDir() && prefixDirInfo.isReadable() ) if ( prefixDirInfo.isDir() && prefixDirInfo.isReadable() )
{ {
m_prefixDirectory = defaultPrefixDirectory; m_projectDirectory = defaultProjectDirectory;
} }
else else
{ {
m_prefixDirectory = QStringLiteral( "." ); m_projectDirectory = QStringLiteral( "." );
} }
QFileInfo etcDirInfo { defaultEtcDirectory }; QFileInfo etcDirInfo { defaultEtcDirectory };
@ -81,160 +112,171 @@ MYXLIB_INLINE void Paths::setupSystemDirectories( const QString& defaultPrefixDi
} // Paths::setupSystemDirectories } // Paths::setupSystemDirectories
MYXLIB_INLINE void Paths::setupUserDirectories()
{
QString prefix;
if ( !m_organizationName.isEmpty() )
{
prefix = "/" + m_organizationName;
if ( !m_themeName.isEmpty() ) { prefix.append( "-" + m_themeName ); }
}
prefix.append( "/" + m_projectName );
m_userConfigDirectory = m_configDirectory + prefix;
m_userConstDataDirectory = m_dataDirectory + prefix + "/share";
m_userVarDataDirectory = m_dataDirectory + prefix + "/var";
m_userLogDirectory = m_dataDirectory + prefix + "/log";
}
MYXLIB_INLINE Paths::HierarchyType Paths::getHierarchyType() MYXLIB_INLINE Paths::HierarchyType Paths::getHierarchyType()
{ {
QRegExp binUnityRegexp( "/s*bin/unity$" ); if ( m_unityBinDirRegex.match( m_executableDirectory ).hasMatch() )
auto binaryDir = m_executableDirectory;
if ( binUnityRegexp.indexIn( binaryDir ) >= 0 )
{ {
binaryDir.remove( binUnityRegexp );
setupSystemDirectories( binaryDir,
binaryDir + "/etc",
binaryDir + "/share",
binaryDir + "/var",
binaryDir + "/log" );
return ( HierarchyType::kDevelopment ); return ( HierarchyType::kDevelopment );
} }
QRegExp binRegexp( "/s*bin$" ); if ( !m_binDirRegex.match( m_executableDirectory ).hasMatch() )
if ( binRegexp.indexIn( binaryDir ) == -1 )
{ {
m_prefixDirectory = m_executableDirectory;
m_systemConstDataDirectory = m_executableDirectory;
m_systemVarDataDirectory = m_executableDirectory;
m_systemConfigDirectory = m_executableDirectory;
m_systemLogDirectory = m_executableDirectory;
return ( HierarchyType::kFlat ); return ( HierarchyType::kFlat );
} }
QRegExp optRegexp( "^/opt(/|/.+/)" + m_projectName + "/" ); if ( m_executableDirectory.startsWith( QStringLiteral( "/opt/" ) ) )
if ( optRegexp.indexIn( binaryDir ) >= 0 )
{ {
binaryDir.remove( binRegexp );
setupSystemDirectories( binaryDir,
binaryDir + "/etc",
binaryDir + "/share",
binaryDir + "/var",
binaryDir + "/log" );
return ( HierarchyType::kOpt ); return ( HierarchyType::kOpt );
} }
if ( binaryDir.startsWith( QStringLiteral( "/usr/local/bin" ) ) ) if ( m_executableDirectory.startsWith( QStringLiteral( "/usr/local/bin/" ) ) )
{ {
setupSystemDirectories( QStringLiteral( "/usr/local" ),
"/usr/local/etc/" + m_projectName,
"/usr/local/share/" + m_projectName,
"/var/lib/" + m_projectName,
"/var/log/" + m_projectName );
return ( HierarchyType::kUsrLocal ); return ( HierarchyType::kUsrLocal );
} }
if ( binaryDir.startsWith( QStringLiteral( "/usr/local" ) ) ) if ( m_executableDirectory.startsWith( QStringLiteral( "/usr/local/" ) ) )
{ {
binaryDir.remove( QRegExp( "/bin$" ) );
setupSystemDirectories( binaryDir,
binaryDir + "/etc",
binaryDir + "/share",
binaryDir + "/var",
binaryDir + "/log" );
return ( HierarchyType::kUsrLocalOrg ); return ( HierarchyType::kUsrLocalOrg );
} }
if ( binaryDir.startsWith( QStringLiteral( "/usr" ) ) ) if ( m_executableDirectory.startsWith( QStringLiteral( "/usr/bin/" ) ) )
{ {
setupSystemDirectories( QStringLiteral( "/usr" ),
"/etc/" + m_projectName,
"/usr/share/" + m_projectName,
"/var/lib/" + m_projectName,
"/var/log/" + m_projectName );
return ( HierarchyType::kUsr ); return ( HierarchyType::kUsr );
} }
if ( binaryDir.startsWith( m_homeDirectory + "/.local/bin" ) || if ( m_executableDirectory.startsWith( m_homeDirectory + "/.local/bin/" ) ||
binaryDir.startsWith( m_homeDirectory + "/bin" ) ) m_executableDirectory.startsWith( m_homeDirectory + "/bin/" ) )
{ {
m_prefixDirectory = m_homeDirectory;
m_systemConfigDirectory = m_userConfigDirectory;
m_systemConstDataDirectory = m_userConstDataDirectory;
m_systemVarDataDirectory = m_userVarDataDirectory;
m_systemLogDirectory = m_userLogDirectory;
return( HierarchyType::kHome ); return( HierarchyType::kHome );
} }
binaryDir.remove( binRegexp );
setupSystemDirectories( binaryDir,
binaryDir + "/etc",
binaryDir + "/share",
binaryDir + "/var",
binaryDir + "/log" );
return ( HierarchyType::kDevelopment ); return ( HierarchyType::kDevelopment );
} // Paths::getHierarchyType } // Paths::getHierarchyType
MYXLIB_INLINE bool Paths::initCommon() MYXLIB_INLINE void Paths::calculatePaths( HierarchyType hType )
{ {
m_homeDirectory = QDir::homePath(); auto directory = m_executableDirectory;
m_tempDirectory = QDir::tempPath(); setupUserDirectories();
auto configHome = QString::fromLocal8Bit( qgetenv( "XDG_CONFIG_HOME" ) ); switch ( hType )
if ( configHome.isEmpty() )
{ {
configHome = m_homeDirectory + "/.config"; case HierarchyType::kFlat:
} setupSystemDirectories( directory, directory, directory, directory, directory );
m_userConfigDirectory = configHome + "/" + m_projectName; break;
auto dataHome = QString::fromLocal8Bit( qgetenv( "XDG_DATA_HOME" ) ); case HierarchyType::kOpt:
if ( dataHome.isEmpty() ) processOptHierarhy();
break;
case HierarchyType::kUsr:
setupSystemDirectories( QStringLiteral( "/usr" ),
"/etc/" + m_projectName,
"/usr/share/" + m_projectName,
"/var/lib/" + m_projectName,
"/var/log/" + m_projectName );
break;
case HierarchyType::kUsrLocal:
setupSystemDirectories( QStringLiteral( "/usr/local" ),
"/usr/local/etc/" + m_projectName,
"/usr/local/share/" + m_projectName,
"/var/lib/" + m_projectName,
"/var/log/" + m_projectName );
break;
case HierarchyType::kUsrLocalOrg:
directory.remove( m_binDirRegex );
setupSystemDirectories( directory,
directory + "/etc",
directory + "/share",
directory + "/var",
directory + "/log" );
break;
case HierarchyType::kHome:
m_projectDirectory = m_homeDirectory;
m_systemConfigDirectory = m_userConfigDirectory;
m_systemConstDataDirectory = m_userConstDataDirectory;
m_systemVarDataDirectory = m_userVarDataDirectory;
m_systemLogDirectory = m_userLogDirectory;
break;
case HierarchyType::kDevelopment:
directory.remove( m_unityBinDirRegex );
directory.remove( m_binDirRegex );
setupSystemDirectories( directory,
directory + "/etc",
directory + "/share",
directory + "/var",
directory + "/log" );
break;
case HierarchyType::kUndefined:
;
} // switch
setupUserDirectories();
} // Paths::calculatePaths
MYXLIB_INLINE void Paths::processOptHierarhy()
{
auto directory = m_executableDirectory;
if ( m_autodetect )
{ {
dataHome = m_homeDirectory + "/.local/share"; QRegularExpression regex( "^/opt/(.+?)-(.+?)/(.+?)/" );
QRegularExpressionMatch match = regex.match( m_executableDirectory );
if ( match.hasMatch() )
{
m_organizationName = match.captured( 1 );
m_themeName = match.captured( 2 );
m_projectName = match.captured( 3 );
QRegularExpression vr( "(.+?)\\.(.+)" );
QRegularExpressionMatch vm = vr.match( m_themeName );
if ( vm.hasMatch() )
{
m_themeName = vm.captured( 1 );
m_version = vm.captured( 2 );
}
}
else
{
regex.setPattern( "^/opt/(.+?)/(.+?)/" );
match = regex.match( m_executableDirectory );
if ( match.hasMatch() )
{
m_organizationName = match.captured( 1 );
m_projectName = match.captured( 2 );
}
}
} }
dataHome += "/" + m_projectName;
m_userConstDataDirectory = dataHome + "/share";
m_userVarDataDirectory = dataHome + "/var";
m_userLogDirectory = dataHome + "/log";
m_hierarchyType = getHierarchyType(); directory.remove( m_binDirRegex );
setupSystemDirectories( directory,
m_configFilePath = m_systemConfigDirectory + "/" + m_configFileName; directory + "/etc",
directory + "/share",
return( true ); directory + "/var",
} // Paths::updatePaths directory + "/log" );
setupUserDirectories();
} // Paths::processOptHierarhy
MYXLIB_INLINE bool Paths::init()
{
m_projectName = m_executableName;
m_configFileName = m_executableName + ".conf";
return( initCommon() );
}
MYXLIB_INLINE bool Paths::init( const QString& configFileName )
{
m_projectName = m_executableName;
m_configFileName = configFileName;
return( initCommon() );
}
MYXLIB_INLINE bool Paths::init( const QString& projectName, const QString& configFileExtension )
{
m_projectName = projectName.isEmpty() ? m_executableName
: projectName;
auto ext = configFileExtension.isEmpty() ? QStringLiteral( "conf" )
: configFileExtension;
m_configFileName = m_projectName + "." + ext;
return( initCommon() );
}
MYXLIB_INLINE bool Paths::makeDefaultSystemDirectories() MYXLIB_INLINE bool Paths::makeDefaultSystemDirectories()
@ -271,25 +313,24 @@ MYXLIB_INLINE bool Paths::makeDefaultDirectories()
} }
MYXLIB_INLINE QString Paths::findConfigFile( const QString& defaultConfigFile ) MYXLIB_INLINE QString Paths::findConfigFile( const QString& configFileName )
{ {
if ( !defaultConfigFile.isEmpty() && QFileInfo( defaultConfigFile ).isReadable() ) if ( !configFileName.isEmpty() && QFileInfo( configFileName ).isReadable() )
{ {
m_configFilePath = defaultConfigFile; return( configFileName );
return( defaultConfigFile );
} }
auto fileName = QString::fromLocal8Bit( qgetenv( QCoreApplication::applicationName() auto fileName = QString::fromLocal8Bit( qgetenv( QCoreApplication::applicationName()
.toUpper().toUtf8() + "_CONFIG" ) ); .toUpper().toUtf8() + "_CONFIG" ) );
if ( QFileInfo( fileName ).isReadable() ) if ( QFileInfo( fileName ).isReadable() )
{ {
m_configFilePath = fileName;
return( fileName ); return( fileName );
} }
if ( QFileInfo( m_configFilePath ).isReadable() ) QString autoConfigFile = m_systemConfigDirectory + "/" + m_executableName;
if ( QFileInfo( autoConfigFile ).isReadable() )
{ {
return( m_configFilePath ); return( configFileName );
} }
return( QString() ); return( QString() );
@ -308,18 +349,6 @@ MYXLIB_INLINE const QString& Paths::systemConfigDirectory() const
} }
MYXLIB_INLINE const QString& Paths::configFilePath() const
{
return( m_configFilePath );
}
MYXLIB_INLINE const QString& Paths::configFileName() const
{
return( m_configFileName );
}
MYXLIB_INLINE const QString& Paths::userVarDataDirectory() const MYXLIB_INLINE const QString& Paths::userVarDataDirectory() const
{ {
return( m_userVarDataDirectory ); return( m_userVarDataDirectory );
@ -374,6 +403,36 @@ MYXLIB_INLINE const QString& Paths::projectName() const
} }
MYXLIB_INLINE void Paths::setProjectName( const QString& name )
{
m_projectName = name;
}
MYXLIB_INLINE const QString& Paths::organizationName() const
{
return( m_organizationName );
}
MYXLIB_INLINE void Paths::setOrganizationName( const QString& name )
{
m_organizationName = name;
}
MYXLIB_INLINE const QString& Paths::themeName() const
{
return( m_themeName );
}
MYXLIB_INLINE void Paths::setThemeName( const QString& name )
{
m_themeName = name;
}
MYXLIB_INLINE const QString& Paths::executableName() const MYXLIB_INLINE const QString& Paths::executableName() const
{ {
return( m_executableName ); return( m_executableName );
@ -392,9 +451,9 @@ MYXLIB_INLINE const QString& Paths::executableDirectory() const
} }
MYXLIB_INLINE const QString& Paths::prefixDirectory() const MYXLIB_INLINE const QString& Paths::projectDirectory() const
{ {
return( m_prefixDirectory ); return( m_projectDirectory );
} }
} // namespace filesystem } // namespace filesystem

View File

@ -1,5 +1,4 @@
/** /** @file paths.hpp
* @file paths.hpp
* @brief Стандартные пути к каталогам и файлам * @brief Стандартные пути к каталогам и файлам
*/ */
@ -12,35 +11,37 @@
#include <QDir> #include <QDir>
#include <QFileInfo> #include <QFileInfo>
#include <QRegularExpression>
#include <QString> #include <QString>
namespace myx { namespace myx {
namespace filesystem { namespace filesystem {
/// @brief Класс, предоставляющий методы для получения стандартных путей к каталогам и файлам /** @brief Класс, предоставляющий методы для получения стандартных путей к каталогам и файлам */
class Paths class Paths
{ {
enum class HierarchyType : intptr_t enum class HierarchyType : intptr_t
{ {
/// @brief Тип расположения файлов не определён /** @brief Тип расположения файлов не определён */
kUndefined = 0x00, kUndefined = 0x00,
/// @brief Не определено ни одно из типовых размещений файлов /** @brief Не определено ни одно из типовых размещений файлов
/// @details Если исполняемый файл не находится в каталоге bin или не найдены * @details Если исполняемый файл не находится в каталоге bin или не найдены
/// необходимые сопутствующие каталоги, то предполается, * необходимые сопутствующие каталоги, то предполается,
/// что все файлы находятся в одном каталоге с исполняемым файлом * что все файлы находятся в одном каталоге с исполняемым файлом
*/
kFlat = 0x01, kFlat = 0x01,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /opt /** @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /opt */
kOpt = 0x02, kOpt = 0x02,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /usr /** @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии / usr */
kUsr = 0x03, kUsr = 0x03,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /usr/local /** @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /usr/local */
kUsrLocal = 0x04, kUsrLocal = 0x04,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /usr/local/ORG (используется для работ в проекте Сирена) /** @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /usr/local/ORG (используется для работ в проекте Сирена) */
kUsrLocalOrg = 0x05, kUsrLocalOrg = 0x05,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /home /** @brief Исполняемый файл и сопутствующие каталоги находятся в иерахии /home */
kHome = 0x06, kHome = 0x06,
/// @brief Исполняемый файл и сопутствующие каталоги находятся в каталоге программного проекта /** @brief Исполняемый файл и сопутствующие каталоги находятся в каталоге программного проекта */
kDevelopment = 0x07 kDevelopment = 0x07
}; };
@ -60,186 +61,163 @@ public:
return( sPaths ); return( sPaths );
} }
/** /** @brief Обновление путей с учётом расположения исполняемого файла */
* @brief Обновление путей с учётом расположения исполняемого файла bool init( bool autodetect = true );
*/
bool init();
/** /** @brief Создание стандартных системных каталогов */
* @brief Обновление путей с учётом расположения исполняемого файла
* @param configFileName Имя файла настроек
*/
bool init( const QString& configFileName );
/**
* @brief Обновление путей с учётом расположения исполняемого файла
* @param projectName Имя проекта
* @param configFileExtension Расширение для файла настроек
*/
bool init( const QString& projectName, const QString& configFileExtension );
/**
* @brief Создание стандартных каталогов
*/
bool makeDefaultSystemDirectories(); bool makeDefaultSystemDirectories();
/** @brief Создание стандартных пользовательских каталогов */
bool makeDefaultUserDirectories(); bool makeDefaultUserDirectories();
/** @brief Создание стандартных каталогов */
bool makeDefaultDirectories(); bool makeDefaultDirectories();
/** /** @brief Поиск существующего файла настойки.
* @brief Поиск существующего файла настойки.
* Поиск выполняется до тех пор пока не будет найден файл в следующем порядке: * Поиск выполняется до тех пор пока не будет найден файл в следующем порядке:
* 1. Имя файла, указанное в качестве параметра функции * 1. Имя файла, указанное в качестве параметра функции
* 2. Имя файла, заданное переменной окружения вида PROJECT_NAME_CONFIG * 2. Имя файла, заданное переменной окружения вида EXECUTABLE_NAME_CONFIG
* 3. Имя файла, полученное из внутренней переменной класса * 3. Имя файла, полученное из имени каталога системных настроек и имени исполняемого файла
* Если файл настройки не будет найден, то будет возвращена пустая строка * Если файл настройки не будет найден, то будет возвращена пустая строка
*/ */
QString findConfigFile( const QString& defaultConfigFile = QLatin1String("") ); QString findConfigFile( const QString& configFileName = QLatin1String( "" ) );
/** /** @brief Имя исполняемого файла */
* @brief Полный путь к базовому каталогу
*/
const QString& prefixDirectory() const;
/**
* @brief Имя исполняемого файла
*/
const QString& executableName() const; const QString& executableName() const;
/** /** @brief Полный путь к исполняемому файлу */
* @brief Полный путь к исполняемому файлу
*/
const QString& executableFilePath() const; const QString& executableFilePath() const;
/** /** @brief Полный путь к каталогу с исполняемым файлом */
* @brief Полный путь к каталогу с исполняемым файлом
*/
const QString& executableDirectory() const; const QString& executableDirectory() const;
/** /** @brief Полный путь к пользовательскому каталогу с файлами настройки */
* @brief Имя файла настройки
*/
const QString& configFileName() const;
/**
* @brief Расширение у файла настройки
*/
const QString& configFileExtension() const;
/**
* @brief Полный путь к файлу настройки
*/
const QString& configFilePath() const;
/**
* @brief Полный путь к пользовательскому каталогу с файлами настройки
*/
const QString& userConfigDirectory() const; const QString& userConfigDirectory() const;
/** /** @brief Полный путь к системному каталогу с файлами настройки */
* @brief Полный путь к системному каталогу с файлами настройки
*/
const QString& systemConfigDirectory() const; const QString& systemConfigDirectory() const;
/** /** @brief Полный путь к пользовательскому каталогу с изменяемыми файлами */
* @brief Полный путь к пользовательскому каталогу с изменяемыми файлами
*/
const QString& userVarDataDirectory() const; const QString& userVarDataDirectory() const;
/** /** @brief Полный путь к системному каталогу с изменяемыми файлами */
* @brief Полный путь к системному каталогу с изменяемыми файлами
*/
const QString& systemVarDataDirectory() const; const QString& systemVarDataDirectory() const;
/** /** @brief Полный путь к пользовательскому каталогу с неизменяемыми файлами */
* @brief Полный путь к пользовательскому каталогу с неизменяемыми файлами
*/
const QString& userConstDataDirectory() const; const QString& userConstDataDirectory() const;
/** /** @brief Полный путь к системному каталогу с неизменяемыми файлами */
* @brief Полный путь к системному каталогу с неизменяемыми файлами
*/
const QString& systemConstDataDirectory() const; const QString& systemConstDataDirectory() const;
/** /** @brief Полный путь к пользовательскому каталогу с журналами работы */
* @brief Полный путь к пользовательскому каталогу с журналами работы
*/
const QString& userLogDirectory() const; const QString& userLogDirectory() const;
/** /** @brief Полный путь к системному каталогу с журналами работы */
* @brief Полный путь к системному каталогу с журналами работы
*/
const QString& systemLogDirectory() const; const QString& systemLogDirectory() const;
/** /** @brief Полный путь к каталогу с временными файлами */
* @brief Полный путь к каталогу с временными файлами
*/
const QString& tempDirectory() const; const QString& tempDirectory() const;
/** /** @brief Полный путь к домашнему каталогу текущего пользователя */
* @brief Полный путь к домашнему каталогу текущего пользователя
*/
const QString& homeDirectory() const; const QString& homeDirectory() const;
/** /** @brief Имя каталога для работы (темы) */
* @brief Имя подкаталога для проекта const QString& themeDirectory() const;
*/
/** @brief Имя каталога для проекта */
const QString& projectDirectory() const;
/** @brief Название организации */
const QString& organizationName() const;
void setOrganizationName( const QString& name );
/** @brief Название работы (темы) */
const QString& themeName() const;
void setThemeName( const QString& name );
/** @brief Название программного проекта */
const QString& projectName() const; const QString& projectName() const;
void setProjectName( const QString& name );
protected: protected:
Paths(); Paths();
~Paths() = default; ~Paths() = default;
private: private:
/// @brief Тип расположения файлов по каталогам /** @brief Тип расположения файлов по каталогам */
HierarchyType m_hierarchyType { HierarchyType::kFlat }; HierarchyType m_hierarchyType { HierarchyType::kFlat };
/// @brief Имя проекта, которое используется при формировании имён файлов и каталогов /** @brief Автоматически определять значения organizationName, themeName и projectName
* @detail Если true, то пытаться автоматически определять значения переменных
* на основании полного пути к исполняемому файлу.
* Иначе использовать значения переменных, указанные пользователем.
*/
bool m_autodetect { true };
/** @brief Название организации */
QString m_organizationName;
/** @brief Название работы (темы) */
QString m_themeName;
/** @brief Номер версии установленного пакета */
QString m_version;
/** @brief Имя проекта, которое используется при формировании имён файлов и каталогов */
QString m_projectName; QString m_projectName;
QString m_executableName; QString m_executableName;
QString m_executableFilePath; QString m_executableFilePath;
QString m_executableDirectory; QString m_executableDirectory;
/// @brief Общий префикс для файлов проекта /** @brief Общий каталог для файлов работы (темы) */
QString m_prefixDirectory; QString m_themeDirectory;
/// @brief Путь к каталогу с временными файлами /** @brief Общий каталог для файлов проекта */
QString m_projectDirectory;
/** @brief Путь к каталогу с временными файлами */
QString m_tempDirectory; QString m_tempDirectory;
/// @brief Путь к домашнему каталогу текущего пользователя /** @brief Путь к домашнему каталогу текущего пользователя */
QString m_homeDirectory; QString m_homeDirectory;
/** @brief Путь к общему пользовательскому каталогу настроек */
QString m_configDirectory;
/** @brief Путь к общему пользовательскому каталогу данных */
QString m_dataDirectory;
/// @brief Путь к пользовательскому каталогу с изменяемыми файлами /** @brief Путь к пользовательскому каталогу с изменяемыми файлами */
QString m_userVarDataDirectory; QString m_userVarDataDirectory;
/// @brief Путь к системному каталогу с изменяемыми файлами /** @brief Путь к системному каталогу с изменяемыми файлами */
QString m_systemVarDataDirectory; QString m_systemVarDataDirectory;
/// @brief Путь к пользовательскому каталогу с неизменяемыми файлами /** @brief Путь к пользовательскому каталогу с неизменяемыми файлами */
QString m_userConstDataDirectory; QString m_userConstDataDirectory;
/// @brief Путь к системному каталогу с неизменяемыми файлами /** @brief Путь к системному каталогу с неизменяемыми файлами */
QString m_systemConstDataDirectory; QString m_systemConstDataDirectory;
/// @brief Путь к пользовательскому каталогу с журналами работы /** @brief Путь к пользовательскому каталогу с журналами работы */
QString m_userLogDirectory; QString m_userLogDirectory;
/// @brief Путь к системному каталогу с журналами работы /** @brief Путь к системному каталогу с журналами работы */
QString m_systemLogDirectory; QString m_systemLogDirectory;
/// @brief Путь к пользовательскому каталогу с файлами настройки /** @brief Путь к пользовательскому каталогу с файлами настройки */
QString m_userConfigDirectory; QString m_userConfigDirectory;
/// @brief Путь к системному каталогу с файлами настройки /** @brief Путь к системному каталогу с файлами настройки */
QString m_systemConfigDirectory; QString m_systemConfigDirectory;
/// @brief Полный путь к файлу настройки QRegularExpression m_binDirRegex;
QString m_configFilePath; QRegularExpression m_unityBinDirRegex;
/// @brief Имя файла настройки
QString m_configFileName;
void setupSystemDirectories( const QString& defaultPrefixDirectory, void setupSystemDirectories( const QString& defaultProjectDirectory,
const QString& defaultEtcDirectory, const QString& defaultEtcDirectory,
const QString& defaultConstDataDirectory, const QString& defaultConstDataDirectory,
const QString& defaultVarDataDirectory, const QString& defaultVarDataDirectory,
const QString& defaultLogDirectory ); const QString& defaultLogDirectory );
bool initCommon(); void setupUserDirectories();
HierarchyType getHierarchyType(); HierarchyType getHierarchyType();
void calculatePaths( HierarchyType hType );
void processOptHierarhy();
}; // class Paths }; // class Paths
} // namespace filesystem } // namespace filesystem