swift
swiftdirectories.h
Go to the documentation of this file.
1 // SPDX-FileCopyrightText: Copyright (C) 2020 swift Project Community / Contributors
2 // SPDX-License-Identifier: GPL-3.0-or-later OR LicenseRef-swift-pilot-client-1
3 
5 
6 #ifndef SWIFT_MISC_SWIFTDIRECTORIES_H
7 #define SWIFT_MISC_SWIFTDIRECTORIES_H
8 
9 #include <QFileInfoList>
10 #include <QString>
11 
12 #include "misc/swiftmiscexport.h"
13 
14 namespace swift::misc
15 {
20  {
21  public:
25  static const QString &binDirectory();
26 
28  static const QString &pluginsDirectory();
29 
32  static const QString &audioPluginDirectory();
33 
36  static const QString &getXSwiftBusBuildDirectory();
37 
39  static QString executableFilePath(const QString &executable);
40 
43  static const QString &applicationDataDirectory();
44 
46  static const QFileInfoList &applicationDataDirectories();
47 
50 
52  static QFileInfoList currentApplicationDataDirectories();
53 
55  static QStringList applicationDataDirectoryList(bool withoutCurrent = false, bool decodedDirName = false);
56 
59  static const QString &normalizedApplicationDataDirectory();
60 
63  static const QString &shareDirectory();
64 
66  static const QString &shareTestDirectory();
67 
69  static const QString &shareTerrainProbeDirectory();
70 
72  static const QString &shareMatchingScriptDirectory();
73 
75  static const QString &bootstrapFileName();
76 
78  static const QString &bootstrapResourceFilePath();
79 
81  static const QString &staticDbFilesDirectory();
82 
84  static const QString &soundFilesDirectory();
85 
87  static const QString &stylesheetsDirectory();
88 
90  static const QString &htmlDirectory();
91 
93  static const QString &legalDirectory();
94 
96  static const QString &aboutFilePath();
97 
99  static const QString &testFilesDirectory();
100 
102  static const QString &htmlTemplateFilePath();
103 
105  static const QString &documentationDirectory();
106 
109  static const QString &logDirectory();
110 
112  static const QString &crashpadDirectory();
113 
115  static const QString &crashpadDatabaseDirectory();
116 
118  static const QString &crashpadMetricsDirectory();
119 
121  static QStringList verifyRuntimeDirectoriesAndFiles();
122 
124  static QString soundFilePathOrDefaultPath(const QString &directory, const QString &fileName);
125 
126  private:
130  static const QString &normalizedApplicationDirectory();
131  };
132 } // namespace swift::misc
133 
134 #endif // SWIFT_MISC_SWIFTDIRECTORIES_H
Locations of important directories for swift files.
static const QString & soundFilesDirectory()
Where sound files are located.
static const QString & aboutFilePath()
The about document file location.
static const QString & getXSwiftBusBuildDirectory()
The build directory.
static const QString & crashpadMetricsDirectory()
Directory for crashpad metrics files.
static const QString & applicationDataDirectory()
swift application data directory, contains 0..n swift installation directories
static const QString & audioPluginDirectory()
Audio plugins directory for Qt audio.
static const QString & shareMatchingScriptDirectory()
Matching script examples directories.
static const QString & htmlTemplateFilePath()
HTML template.
static const QString & binDirectory()
Returns the bin directory. On Windows/Linux this is the same directory as QCoreApplication::applicati...
static const QString & normalizedApplicationDataDirectory()
swift application data directory for one specific installation (a version)
static const QString & shareTestDirectory()
The test data directory.
static const QString & crashpadDatabaseDirectory()
Directory for crashpad database files.
static const QString & bootstrapResourceFilePath()
Bootstrap resource file path.
static const QString & logDirectory()
Directory for log files.
static QStringList applicationDataDirectoryList(bool withoutCurrent=false, bool decodedDirName=false)
swift application data sub directories
static const QString & crashpadDirectory()
Directory for crashpad files.
static const QString & bootstrapFileName()
Bootstrap file name.
static const QFileInfoList & applicationDataDirectories()
swift application data sub directories
static const QString & legalDirectory()
Where Legal files are located.
static QString soundFilePathOrDefaultPath(const QString &directory, const QString &fileName)
File path (with file name) of file name and.
static QString executableFilePath(const QString &executable)
The executable file path.
static const QString & stylesheetsDirectory()
Where qss files are located.
static const QString & testFilesDirectory()
Where test files are located.
static const QString & pluginsDirectory()
Plugins directory.
static const QString & staticDbFilesDirectory()
Where static DB files are located.
static const QString & shareDirectory()
Where resource files (static DB files, ...) etc are located.
static int applicationDataDirectoriesCount()
number of data directories (including this version)
static const QString & shareTerrainProbeDirectory()
FSX/P3D terrain probe.
static QFileInfoList currentApplicationDataDirectories()
swift application data sub directories
static const QString & documentationDirectory()
Directory where data can be stored.
static const QString & htmlDirectory()
Where HTML files are located.
static QStringList verifyRuntimeDirectoriesAndFiles()
Check if the (most important) runtime directories are available.
Free functions in swift::misc.
#define SWIFT_MISC_EXPORT
Export a class or function from the library.