flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-11 06:25:33 +08:00
Code Issues Packages Projects Releases Wiki Activity

Ref T103, Unified naming of directory functions

Browse Source 
* some started with get/some not (removed get, get is normally used for our getters)
* some used swift, getSwiftXZY dir (removed swift)
* used full word "directory", not dir/directory mixed
This commit is contained in:
Klaus Basan
2017-07-06 23:02:13 +02:00
committed by Mathew Sutcliffe
parent debd9c802f
commit a9198e4f13
24 changed files with 124 additions and 118 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/blackmisc/aviation/airlineicaocode.cpp
View File

@@ -480,7 +480,7 @@ namespace BlackMisc
//! \private
QSet<int> iconIdsImpl()
{
QDir dir(CDirectoryUtils::getImagesAirlinesDir());
QDir dir(CDirectoryUtils::imagesAirlinesDirectory());
Q_ASSERT_X(dir.exists(), Q_FUNC_INFO, "image directory missing");
QSet<int> ids;

93
src/blackmisc/directoryutils.cpp
View File

@@ -33,7 +33,7 @@ namespace BlackMisc
return appDirectory.absolutePath();
}
const QString &CDirectoryUtils::getBinDir()
const QString &CDirectoryUtils::binDirectory()
{
static const QString binDir(binDirectoryImpl());
return binDir;
@@ -41,7 +41,7 @@ namespace BlackMisc
QString normalizedApplicationDirectoryImpl()
{
QString appDir = CDirectoryUtils::getBinDir();
QString appDir = CDirectoryUtils::binDirectory();
Q_ASSERT(appDir.size() > 0);
// Remove leading '/' on Unix
if (appDir.at(0) == '/') { appDir.remove(0, 1); }
@@ -54,23 +54,30 @@ namespace BlackMisc
return appDir;
}
const QString &CDirectoryUtils::swiftApplicationDataDirectory()
bool CDirectoryUtils::isMacOSXAppBundle()
{
static const bool appBundle = CBuildConfig::isRunningOnMacOSXPlatform() &&
qApp->applicationDirPath().contains("Contents/MacOS", Qt::CaseInsensitive);
return appBundle;
}
const QString &CDirectoryUtils::applicationDataDirectory()
{
static const QString p = CFileUtils::appendFilePaths(QStandardPaths::writableLocation(QStandardPaths::GenericDataLocation), "/org.swift-project/");
return p;
}
QFileInfoList CDirectoryUtils::swiftApplicationDataDirectories()
QFileInfoList CDirectoryUtils::applicationDataDirectories()
{
QDir swiftAppData(CDirectoryUtils::swiftApplicationDataDirectory()); // contains 1..n subdirs
QDir swiftAppData(CDirectoryUtils::applicationDataDirectory()); // contains 1..n subdirs
if (!swiftAppData.isReadable()) return QFileInfoList();
return swiftAppData.entryInfoList({}, QDir::Dirs | QDir::NoDotAndDotDot, QDir::Time);
}
QStringList CDirectoryUtils::swiftApplicationDataDirectoryList(bool withoutCurrent, bool beautify)
QStringList CDirectoryUtils::applicationDataDirectoryList(bool withoutCurrent, bool beautify)
{
QStringList dirs;
const QFileInfoList directories(CDirectoryUtils::swiftApplicationDataDirectories());
const QFileInfoList directories(CDirectoryUtils::applicationDataDirectories());
for (const QFileInfo &info : directories)
{
if (withoutCurrent && info.filePath().contains(normalizedApplicationDirectory(), Qt::CaseInsensitive)) continue;
@@ -81,21 +88,21 @@ namespace BlackMisc
return dirs;
}
const QString &CDirectoryUtils::swiftNormalizedApplicationDataDirectory()
const QString &CDirectoryUtils::normalizedApplicationDataDirectory()
{
static const QString p = CFileUtils::appendFilePaths(swiftApplicationDataDirectory(), normalizedApplicationDirectory());
static const QString p = CFileUtils::appendFilePaths(applicationDataDirectory(), normalizedApplicationDirectory());
return p;
}
const QString &CDirectoryUtils::getLogDirectory()
const QString &CDirectoryUtils::logDirectory()
{
static const QString p = CFileUtils::appendFilePaths(swiftNormalizedApplicationDataDirectory(), "/logs");
static const QString p = CFileUtils::appendFilePaths(normalizedApplicationDataDirectory(), "/logs");
return p;
}
bool isAppBundleImpl()
{
QDir bundleDir(CDirectoryUtils::getBinDir());
QDir bundleDir(CDirectoryUtils::binDirectory());
bundleDir.cd("../..");
const bool isBundled = QFileInfo(bundleDir.absolutePath()).isBundle();
return isBundled;
@@ -103,7 +110,7 @@ namespace BlackMisc
QString getSwiftShareDirImpl()
{
QDir dir(CDirectoryUtils::getBinDir());
QDir dir(CDirectoryUtils::binDirectory());
bool success = true;
static const bool appBundle = isAppBundleImpl();
@@ -122,7 +129,7 @@ namespace BlackMisc
return "";
}
const QString &CDirectoryUtils::getSwiftShareDir()
const QString &CDirectoryUtils::shareDirectory()
{
static const QString s(getSwiftShareDirImpl());
return s;
@@ -130,14 +137,14 @@ namespace BlackMisc
const QString getBootstrapResourceFileImpl()
{
const QString d(CDirectoryUtils::getSwiftShareDir());
const QString d(CDirectoryUtils::shareDirectory());
if (d.isEmpty()) { return ""; }
const QFile file(QDir::cleanPath(d + QDir::separator() + "shared/boostrap/boostrap.json"));
Q_ASSERT_X(file.exists(), Q_FUNC_INFO, "missing dir");
return QFileInfo(file).absoluteFilePath();
}
const QString &CDirectoryUtils::getBootstrapResourceFile()
const QString &CDirectoryUtils::bootstrapResourceFilePath()
{
static const QString s(getBootstrapResourceFileImpl());
return s;
@@ -145,14 +152,14 @@ namespace BlackMisc
QString getSwiftStaticDbFilesDirImpl()
{
const QString d(CDirectoryUtils::getSwiftShareDir());
const QString d(CDirectoryUtils::shareDirectory());
if (d.isEmpty()) { return ""; }
const QDir dir(QDir::cleanPath(d + QDir::separator() + "shared/dbdata"));
Q_ASSERT_X(dir.exists(), Q_FUNC_INFO, "missing dir");
return dir.absolutePath();
}
const QString &CDirectoryUtils::getSwiftStaticDbFilesDir()
const QString &CDirectoryUtils::staticDbFilesDirectory()
{
static QString s(getSwiftStaticDbFilesDirImpl());
return s;
@@ -160,14 +167,14 @@ namespace BlackMisc
QString getSoundFilesDirImpl()
{
const QString d(CDirectoryUtils::getSwiftShareDir());
const QString d(CDirectoryUtils::shareDirectory());
if (d.isEmpty()) { return ""; }
const QDir dir(QDir::cleanPath(d + QDir::separator() + "sounds"));
Q_ASSERT_X(dir.exists(), Q_FUNC_INFO, "missing dir");
return dir.absolutePath();
}
const QString &CDirectoryUtils::getSoundFilesDir()
const QString &CDirectoryUtils::soundFilesDirectory()
{
static QString s(getSoundFilesDirImpl());
return s;
@@ -175,14 +182,14 @@ namespace BlackMisc
QString getStylesheetsDirImpl()
{
const QString d(CDirectoryUtils::getSwiftShareDir());
const QString d(CDirectoryUtils::shareDirectory());
if (d.isEmpty()) { return ""; }
const QDir dir(QDir::cleanPath(d + QDir::separator() + "qss"));
Q_ASSERT_X(dir.exists(), Q_FUNC_INFO, "missing dir");
return dir.absolutePath();
}
const QString &CDirectoryUtils::getStylesheetsDir()
const QString &CDirectoryUtils::stylesheetsDirectory()
{
static QString s(getStylesheetsDirImpl());
return s;
@@ -190,39 +197,39 @@ namespace BlackMisc
QString getImagesDirImpl()
{
const QString d(CDirectoryUtils::getSwiftShareDir());
const QString d(CDirectoryUtils::shareDirectory());
const QDir dir(QDir::cleanPath(d + QDir::separator() + "images"));
Q_ASSERT_X(dir.exists(), Q_FUNC_INFO, "missing dir");
return dir.absolutePath();
}
const QString &CDirectoryUtils::getImagesDir()
const QString &CDirectoryUtils::imagesDirectory()
{
static const QString s(getImagesDirImpl());
return s;
}
const QString &CDirectoryUtils::getImagesAirlinesDir()
const QString &CDirectoryUtils::imagesAirlinesDirectory()
{
static const QString s(QDir::cleanPath(getImagesDir() + QDir::separator() + "airlines"));
static const QString s(QDir::cleanPath(imagesDirectory() + QDir::separator() + "airlines"));
return s;
}
const QString &CDirectoryUtils::getImagesFlagsDir()
const QString &CDirectoryUtils::imagesFlagsDirectory()
{
static const QString s(QDir::cleanPath(getImagesDir() + QDir::separator() + "flags"));
static const QString s(QDir::cleanPath(imagesDirectory() + QDir::separator() + "flags"));
return s;
}
QString getHtmlDirImpl()
{
const QString d(CDirectoryUtils::getSwiftShareDir());
const QString d(CDirectoryUtils::shareDirectory());
const QDir dir(QDir::cleanPath(d + QDir::separator() + "html"));
Q_ASSERT_X(dir.exists(), Q_FUNC_INFO, "missing dir");
return dir.absolutePath();
}
const QString &CDirectoryUtils::getHtmlDir()
const QString &CDirectoryUtils::htmlDirectory()
{
static const QString s(getHtmlDirImpl());
return s;
@@ -230,42 +237,42 @@ namespace BlackMisc
QString getLegalDirImpl()
{
const QString d(CDirectoryUtils::getSwiftShareDir());
const QString d(CDirectoryUtils::shareDirectory());
const QDir dir(QDir::cleanPath(d + QDir::separator() + "legal"));
Q_ASSERT_X(dir.exists(), Q_FUNC_INFO, "missing dir");
return dir.absolutePath();
}
const QString &CDirectoryUtils::getLegalDir()
const QString &CDirectoryUtils::legalDirectory()
{
static const QString s(getLegalDirImpl());
return s;
}
const QString &CDirectoryUtils::getAboutFileLocation()
const QString &CDirectoryUtils::aboutFilePath()
{
static const QString about = QDir::cleanPath(CDirectoryUtils::getLegalDir() + QDir::separator() + "about.html");
static const QString about = QDir::cleanPath(CDirectoryUtils::legalDirectory() + QDir::separator() + "about.html");
return about;
}
QString getTestFilesDirImpl()
QString testFilesDirImpl()
{
const QString d(CDirectoryUtils::getSwiftShareDir());
const QString d(CDirectoryUtils::shareDirectory());
if (d.isEmpty()) { return ""; }
const QDir dir(QDir::cleanPath(d + QDir::separator() + "test"));
Q_ASSERT_X(dir.exists(), Q_FUNC_INFO, "missing dir");
return dir.absolutePath();
}
const QString &CDirectoryUtils::getTestFilesDir()
const QString &CDirectoryUtils::testFilesDirectory()
{
static QString s(getTestFilesDirImpl());
static QString s(testFilesDirImpl());
return s;
}
const QString &CDirectoryUtils::getHtmlTemplateFileName()
const QString &CDirectoryUtils::htmlTemplateFilePath()
{
static const QString s(getHtmlDir() + QDir::separator() + "swifttemplate.html");
static const QString s(htmlDirectory() + QDir::separator() + "swifttemplate.html");
return s;
}
@@ -279,15 +286,15 @@ namespace BlackMisc
return pathes.first();
}
const QString &CDirectoryUtils::getDocumentationDirectory()
const QString &CDirectoryUtils::documentationDirectory()
{
static const QString d(getDocumentationDirectoryImpl());
return d;
}
const QString &CDirectoryUtils::getCrashpadDirectory()
const QString &CDirectoryUtils::crashpadDirectory()
{
static const QString p = CFileUtils::appendFilePaths(swiftNormalizedApplicationDataDirectory(), "/crashpad");
static const QString p = CFileUtils::appendFilePaths(normalizedApplicationDataDirectory(), "/crashpad");
return p;
}

46
src/blackmisc/directoryutils.h
View File

@@ -29,69 +29,69 @@ namespace BlackMisc
//! QCoreApplication::applicationDirPath(), but on MacOS the exceutable is
//! located deeper in the hierarchy of the bundles
//! \see https://dev.swift-project.org/w/dev/swiftpc/dirstructure/
static const QString &getBinDir();
static const QString &binDirectory();
//! swift application data directory, contains 0..n swift installation directories
static const QString &swiftApplicationDataDirectory();
static const QString &applicationDataDirectory();
//! swift application data sub directories
static QFileInfoList swiftApplicationDataDirectories();
static QFileInfoList applicationDataDirectories();
//! swift application data sub directories
static QStringList swiftApplicationDataDirectoryList(bool withoutCurrent = false, bool beautify = false);
static QStringList applicationDataDirectoryList(bool withoutCurrent = false, bool beautify = false);
//! swift application data directory for one specific installation (a version)
static const QString &swiftNormalizedApplicationDataDirectory();
static const QString &normalizedApplicationDataDirectory();
//! Where resource files (static DB files, ...) etc are located
//! \remark share not shared (do no mix)
static const QString &getSwiftShareDir();
static const QString &shareDirectory();
//! Bootstrap resource directory
static const QString &getBootstrapResourceFile();
//! Bootstrap resource file path
static const QString &bootstrapResourceFilePath();
//! Where static DB files are located
static const QString &getSwiftStaticDbFilesDir();
static const QString &staticDbFilesDirectory();
//! Where sound files are located
static const QString &getSoundFilesDir();
static const QString &soundFilesDirectory();
//! Where qss files are located
static const QString &getStylesheetsDir();
static const QString &stylesheetsDirectory();
//! Where images are located
static const QString &getImagesDir();
static const QString &imagesDirectory();
//! Where airline images are located
static const QString &getImagesAirlinesDir();
static const QString &imagesAirlinesDirectory();
//! Where flags images are located
static const QString &getImagesFlagsDir();
static const QString &imagesFlagsDirectory();
//! Where HTML files are located
static const QString &getHtmlDir();
static const QString &htmlDirectory();
//! Where Legal files are located
static const QString &getLegalDir();
static const QString &legalDirectory();
//! The about document file location
static const QString &getAboutFileLocation();
static const QString &aboutFilePath();
//! Where test files are located
static const QString &getTestFilesDir();
static const QString &testFilesDirectory();
//! Where HTML files are located
static const QString &getHtmlTemplateFileName();
//! HTML template
static const QString &htmlTemplateFilePath();
//! Directory where data can be stored
static const QString &getDocumentationDirectory();
static const QString &documentationDirectory();
//! Directory for log files
//! \remark In BlackMisc so it can also be used from BlackMisc classes
static const QString &getLogDirectory();
static const QString &logDirectory();
//! Directory for log files
static const QString &getCrashpadDirectory();
static const QString &crashpadDirectory();
//! Virtually the inverse operation of CDirectoryUtils::normalizedApplicationDirectory
static QString decodeNormalizedDirectory(const QString &directory);

2
src/blackmisc/icons.cpp
View File

@@ -1155,7 +1155,7 @@ namespace BlackMisc
if (!getResourceFileCache().contains(fileName))
{
const QString path = CFileUtils::appendFilePaths(CDirectoryUtils::getImagesDir(), fileName);
const QString path = CFileUtils::appendFilePaths(CDirectoryUtils::imagesDirectory(), fileName);
QPixmap pm;
const bool s = pm.load(path);
getResourceFileCache().insert(fileName, s ? pm : CIcons::empty());

2
src/blackmisc/simulation/aircraftmodelutils.cpp
View File

@@ -132,7 +132,7 @@ namespace BlackMisc
BLACK_VERIFY_X(dir.exists(), Q_FUNC_INFO, "Directory does not exist");
if (!dir.exists()) { return ""; }
const QString htmlTemplate = CFileUtils::readFileToString(CDirectoryUtils::getHtmlTemplateFileName());
const QString htmlTemplate = CFileUtils::readFileToString(CDirectoryUtils::htmlTemplateFilePath());
const QString fn("airlineAircraftMatrix.html");
const bool ok = CFileUtils::writeStringToFile(htmlTemplate.arg(html), dir.absoluteFilePath(fn));
return ok ? dir.absoluteFilePath(fn) : "";

8
src/blackmisc/simulation/interpolationlogger.cpp
View File

@@ -60,7 +60,7 @@ namespace BlackMisc
QStringList CInterpolationLogger::getLatestLogFiles()
{
QStringList files({ "", ""});
const QString logDir = CDirectoryUtils::getLogDirectory();
const QString logDir = CDirectoryUtils::logDirectory();
QDir logs(logDir);
if (!logs.exists()) { return files; }
logs.setNameFilters(QStringList() << "*interpolation.html" << "*parts.html");
@@ -81,14 +81,14 @@ namespace BlackMisc
{
if (parts.isEmpty() && interpolation.isEmpty()) { return CStatusMessage(static_cast<CInterpolationLogger *>(nullptr)).warning("No data for log"); }
static const QString html = QStringLiteral("Entries: %1\n\n%2");
const QString htmlTemplate = CFileUtils::readFileToString(CDirectoryUtils::getHtmlTemplateFileName());
const QString htmlTemplate = CFileUtils::readFileToString(CDirectoryUtils::htmlTemplateFilePath());
CStatusMessageList msgs;
const QString ts = QDateTime::currentDateTimeUtc().toString("yyyyMMddhhmmss");
const QString htmlInterpolation = CInterpolationLogger::getHtmlInterpolationLog(interpolation);
if (!htmlInterpolation.isEmpty())
{
const QString fn = CFileUtils::appendFilePaths(CDirectoryUtils::getLogDirectory(), QString("%1 interpolation.html").arg(ts));
const QString fn = CFileUtils::appendFilePaths(CDirectoryUtils::logDirectory(), QString("%1 interpolation.html").arg(ts));
const bool s = CFileUtils::writeStringToFile(htmlTemplate.arg(html.arg(interpolation.size()).arg(htmlInterpolation)), fn);
msgs.push_back(CInterpolationLogger::logStatusFileWriting(s, fn));
}
@@ -96,7 +96,7 @@ namespace BlackMisc
const QString htmlParts = CInterpolationLogger::getHtmlPartsLog(parts);
if (!htmlParts.isEmpty())
{
const QString fn = CFileUtils::appendFilePaths(CDirectoryUtils::getLogDirectory(), QString("%1 parts.html").arg(ts));
const QString fn = CFileUtils::appendFilePaths(CDirectoryUtils::logDirectory(), QString("%1 parts.html").arg(ts));
const bool s = CFileUtils::writeStringToFile(htmlTemplate.arg(html.arg(parts.size()).arg(htmlParts)), fn);
msgs.push_back(CInterpolationLogger::logStatusFileWriting(s, fn));
}

14
src/blackmisc/test/testdata.cpp
View File

@@ -239,7 +239,7 @@ namespace BlackMisc
const CAircraftIcaoCode &CTestData::getDBAircraftIcaoB737()
{
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::getTestFilesDir(), "DBAircraftIcaoB737Boeing.json");
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::testFilesDirectory(), "DBAircraftIcaoB737Boeing.json");
static const CAircraftIcaoCode icao(CAircraftIcaoCode::fromJson(json));
Q_ASSERT(icao.hasValidDbKey());
return icao;
@@ -247,7 +247,7 @@ namespace BlackMisc
const CAircraftIcaoCode &CTestData::getDBAircraftIcaoC172()
{
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::getTestFilesDir(), "DBAircraftIcaoC172Cessna.json");
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::testFilesDirectory(), "DBAircraftIcaoC172Cessna.json");
static const CAircraftIcaoCode icao(CAircraftIcaoCode::fromJson(json));
Q_ASSERT(icao.hasValidDbKey());
return icao;
@@ -255,7 +255,7 @@ namespace BlackMisc
const CAirlineIcaoCode &CTestData::getDbAirlineIcaoDLH()
{
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::getTestFilesDir(), "DBAirlineIcaoDLH.json");
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::testFilesDirectory(), "DBAirlineIcaoDLH.json");
static const CAirlineIcaoCode icao(CAirlineIcaoCode::fromJson(json));
Q_ASSERT(icao.hasValidDbKey());
return icao;
@@ -263,7 +263,7 @@ namespace BlackMisc
const CAirlineIcaoCode &CTestData::getDbAirlineIcaoBAW()
{
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::getTestFilesDir(), "DBAirlineIcaoBAW.json");
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::testFilesDirectory(), "DBAirlineIcaoBAW.json");
static const CAirlineIcaoCode icao(CAirlineIcaoCode::fromJson(json));
Q_ASSERT(icao.hasValidDbKey());
return icao;
@@ -271,7 +271,7 @@ namespace BlackMisc
const CLivery &CTestData::getDbLiveryDLHStarAlliance()
{
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::getTestFilesDir(), "DBLiveryDLHStarAlliance.json");
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::testFilesDirectory(), "DBLiveryDLHStarAlliance.json");
static const CLivery livery(CLivery::fromJson(json));
Q_ASSERT(livery.hasValidDbKey());
return livery;
@@ -279,7 +279,7 @@ namespace BlackMisc
const CAircraftModel &CTestData::getDbAircraftModelFsxA2AC172Skyhawk()
{
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::getTestFilesDir(), "DBModelFSXA2ACessnaC172.json");
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::testFilesDirectory(), "DBModelFSXA2ACessnaC172.json");
static const CAircraftModel model(CAircraftModel::fromDatabaseJson(Json::jsonObjectFromString(json)));
Q_ASSERT(model.hasValidDbKey());
Q_ASSERT(!model.getModelString().isEmpty());
@@ -288,7 +288,7 @@ namespace BlackMisc
const CAircraftModel &CTestData::getDbAircraftModelFsxAerosoftA320()
{
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::getTestFilesDir(), "DBModelFSXAerosoftA320.json");
static const QString json = CFileUtils::readFileToString(CDirectoryUtils::testFilesDirectory(), "DBModelFSXAerosoftA320.json");
static const CAircraftModel model(CAircraftModel::fromDatabaseJson(Json::jsonObjectFromString(json)));
Q_ASSERT(model.hasValidDbKey());
Q_ASSERT(!model.getModelString().isEmpty());

2
src/blackmisc/valuecache.cpp
View File

@@ -51,7 +51,7 @@ namespace BlackMisc
//! \private
std::pair<QString &, std::atomic<bool> &> getCacheRootDirectoryMutable()
{
static QString dir = CDirectoryUtils::swiftNormalizedApplicationDataDirectory();
static QString dir = CDirectoryUtils::normalizedApplicationDataDirectory();
static std::atomic<bool> frozen { false };
return { dir, frozen };
}