Qt Utilities 6.15.0
Common Qt related C++ classes and routines used by my applications such as dialogs, widgets and models
Loading...
Searching...
No Matches
resources.cpp
Go to the documentation of this file.
1#include "./resources.h"
2
3#include "resources/config.h"
4
5#include <QDir>
6#include <QFile>
7#include <QFont>
8#include <QIcon>
9#include <QLibraryInfo>
10#include <QLocale>
11#include <QSettings>
12#include <QString>
13#include <QStringBuilder>
14#include <QTranslator>
15#if defined(QT_UTILITIES_GUI_QTWIDGETS)
16#include <QApplication>
17#elif defined(QT_UTILITIES_GUI_QTQUICK)
18#include <QGuiApplication>
19#else
20#include <QCoreApplication>
21#endif
22
23#ifdef Q_OS_ANDROID
24#include <QStandardPaths>
25#endif
26
27#include <iostream>
28
29using namespace std;
30
32inline void initResources()
33{
34 Q_INIT_RESOURCE(qtutilsicons);
35}
36
37inline void cleanupResources()
38{
39 Q_CLEANUP_RESOURCE(qtutilsicons);
40}
42
43namespace QtUtilities {
44
49namespace QtUtilitiesResources {
50
55void init()
56{
57 initResources();
58}
59
64void cleanup()
65{
66 cleanupResources();
67}
68} // namespace QtUtilitiesResources
69
73namespace TranslationFiles {
74
78static QList<QTranslator *> translators;
79
85{
86 static QString path;
87 return path;
88}
89
104void loadQtTranslationFile(std::initializer_list<QString> repositoryNames)
105{
106 loadQtTranslationFile(repositoryNames, QLocale().name());
107}
108
124void loadQtTranslationFile(initializer_list<QString> repositoryNames, const QString &localeName)
125{
126 const auto debugTranslations = qEnvironmentVariableIsSet("QT_DEBUG_TRANSLATIONS");
127 for (const auto &repoName : repositoryNames) {
128 auto *const qtTranslator = new QTranslator(QCoreApplication::instance());
129 const auto fileName = QString(repoName % QChar('_') % localeName);
130
131 QString path;
132 if ((!additionalTranslationFilePath().isEmpty() && qtTranslator->load(fileName, path = additionalTranslationFilePath()))
133 || qtTranslator->load(fileName,
134 path =
135#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
136 QLibraryInfo::location(QLibraryInfo::TranslationsPath)
137#else
138 QLibraryInfo::path(QLibraryInfo::TranslationsPath)
139#endif
140 )
141 || qtTranslator->load(fileName, path = QStringLiteral("../share/qt/translations"))
142 || qtTranslator->load(fileName, path = QStringLiteral(":/translations"))) {
143 QCoreApplication::installTranslator(qtTranslator);
144 translators.append(qtTranslator);
145 if (debugTranslations) {
146 cerr << "Loading translation file for Qt repository \"" << repoName.toLocal8Bit().data() << "\" and the locale \""
147 << localeName.toLocal8Bit().data() << "\" from \"" << path.toLocal8Bit().data() << "\"." << endl;
148 }
149 } else {
150 delete qtTranslator;
151 if (localeName.startsWith(QLatin1String("en"))) {
152 // the translation file is probably just empty (English is built-in and usually only used for plural forms)
153 continue;
154 }
155 cerr << "Unable to load translation file for Qt repository \"" << repoName.toLocal8Bit().data() << "\" and locale "
156 << localeName.toLocal8Bit().data() << "." << endl;
157 }
158 }
159}
160
180void loadApplicationTranslationFile(const QString &configName, const QString &applicationName)
181{
182 // load English translation files as fallback
183 loadApplicationTranslationFile(configName, applicationName, QStringLiteral("en_US"));
184 // load translation files for current locale
185 const auto defaultLocale(QLocale().name());
186 if (defaultLocale != QLatin1String("en_US")) {
187 loadApplicationTranslationFile(configName, applicationName, defaultLocale);
188 }
189}
190
192void logTranslationEvent(
193 const char *event, const QString &configName, const QString &applicationName, const QString &localeName, const QString &path = QString())
194{
195 cerr << event << " translation file for \"" << applicationName.toLocal8Bit().data() << "\"";
196 if (!configName.isEmpty()) {
197 cerr << " (config \"" << configName.toLocal8Bit().data() << "\")";
198 }
199 cerr << " and locale \"" << localeName.toLocal8Bit().data() << '\"';
200 if (!path.isEmpty()) {
201 cerr << " from \"" << path.toLocal8Bit().data() << '\"';
202 }
203 cerr << '.' << endl;
204}
206
227void loadApplicationTranslationFile(const QString &configName, const QString &applicationName, const QString &localeName)
228{
229 auto *const appTranslator = new QTranslator(QCoreApplication::instance());
230 const auto fileName = QString(applicationName % QChar('_') % localeName);
231 const auto directoryName = configName.isEmpty() ? applicationName : QString(applicationName % QChar('-') % configName);
232
233 QString path;
234 if ((!additionalTranslationFilePath().isEmpty() && appTranslator->load(fileName, path = additionalTranslationFilePath()))
235 || appTranslator->load(fileName, path = QStringLiteral(".")) || appTranslator->load(fileName, path = QStringLiteral("../") % directoryName)
236 || appTranslator->load(fileName, path = QStringLiteral("../../") % directoryName)
237 || appTranslator->load(fileName, path = QStringLiteral("./translations"))
238 || appTranslator->load(fileName, path = QStringLiteral("../share/") % directoryName % QStringLiteral("/translations"))
239 || appTranslator->load(fileName, path = QStringLiteral(APP_INSTALL_PREFIX "/share/") % directoryName % QStringLiteral("/translations"))
240 || appTranslator->load(fileName, path = QStringLiteral(":/translations"))) {
241 QCoreApplication::installTranslator(appTranslator);
242 translators.append(appTranslator);
243 if (qEnvironmentVariableIsSet("QT_DEBUG_TRANSLATIONS")) {
244 logTranslationEvent("Loading", configName, applicationName, localeName, path);
245 }
246 } else {
247 delete appTranslator;
248 if (localeName.startsWith(QLatin1String("en"))) {
249 // the translation file is probably just empty (English is built-in and usually only used for plural forms)
250 return;
251 }
252 logTranslationEvent("Unable to load", configName, applicationName, localeName);
253 }
254}
255
261void loadApplicationTranslationFile(const QString &configName, const std::initializer_list<QString> &applicationNames)
262{
263 for (const QString &applicationName : applicationNames) {
264 loadApplicationTranslationFile(configName, applicationName);
265 }
266}
267
274void loadApplicationTranslationFile(const QString &configName, const std::initializer_list<QString> &applicationNames, const QString &localeName)
275{
276 for (const QString &applicationName : applicationNames) {
277 loadApplicationTranslationFile(configName, applicationName, localeName);
278 }
279}
280
285{
286 for (auto *const translator : translators) {
287 QCoreApplication::removeTranslator(translator);
288 }
289 translators.clear();
290}
291
292} // namespace TranslationFiles
293
299namespace ApplicationInstances {
300
301#if defined(QT_UTILITIES_GUI_QTWIDGETS)
305bool hasWidgetsApp()
306{
307 return qobject_cast<QApplication *>(QCoreApplication::instance()) != nullptr;
308}
309#endif
310
311#if defined(QT_UTILITIES_GUI_QTWIDGETS) || defined(QT_UTILITIES_GUI_QTQUICK)
315bool hasGuiApp()
316{
317 return qobject_cast<QGuiApplication *>(QCoreApplication::instance()) != nullptr;
318}
319#endif
320
325{
326 return qobject_cast<QCoreApplication *>(QCoreApplication::instance()) != nullptr;
327}
328} // namespace ApplicationInstances
329
337{
338 // enable dark window frame on Windows if the configured color palette is dark
339 // - supported as of Qt 6.4; no longer required as of Qt 6.5
340 // - see https://bugreports.qt.io/browse/QTBUG-72028?focusedCommentId=677819#comment-677819
341 // and https://www.qt.io/blog/dark-mode-on-windows-11-with-qt-6.5
342#if defined(Q_OS_WINDOWS) && (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)) && (QT_VERSION < QT_VERSION_CHECK(6, 5, 0))
343 if (const auto qtVersion = QLibraryInfo::version();
344 qtVersion >= QVersionNumber(6, 4, 0) && qtVersion < QVersionNumber(6, 5, 0) && !qEnvironmentVariableIsSet("QT_QPA_PLATFORM")) {
345 qputenv("QT_QPA_PLATFORM", "windows:darkmode=1");
346 }
347#endif
348
349 // ensure FONTCONFIG_PATH is set (mainly required for static GNU/Linux builds)
350#ifdef QT_FEATURE_fontdialog
351 if (!qEnvironmentVariableIsSet("FONTCONFIG_PATH") && QDir(QStringLiteral("/etc/fonts")).exists()) {
352 qputenv("FONTCONFIG_PATH", "/etc/fonts");
353 }
354#endif
355
356 // enable settings for High-DPI scaling
357#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
358 if (!QCoreApplication::instance()) {
359 QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling, true);
360 }
361 QCoreApplication::setAttribute(Qt::AA_UseHighDpiPixmaps, true);
362#endif
363}
364
377std::unique_ptr<QSettings> getSettings(const QString &organization, const QString &application)
378{
379 auto settings = std::unique_ptr<QSettings>();
380 const auto portableFileName
381 = application.isEmpty() ? organization + QStringLiteral(".ini") : organization % QChar('/') % application % QStringLiteral(".ini");
382 if (const auto portableFileWorkingDir = QFile(portableFileName); portableFileWorkingDir.exists()) {
383 settings = std::make_unique<QSettings>(portableFileWorkingDir.fileName(), QSettings::IniFormat);
384 } else if (const auto portableFileNextToApp = QFile(QCoreApplication::applicationDirPath() % QChar('/') % portableFileName);
385 portableFileNextToApp.exists()) {
386 settings = std::make_unique<QSettings>(portableFileNextToApp.fileName(), QSettings::IniFormat);
387 } else {
388 settings = std::make_unique<QSettings>(QSettings::IniFormat, QSettings::UserScope, organization, application);
389 // move config created by older versions to new location
390 if (organization != QCoreApplication::organizationName() || application != QCoreApplication::applicationName()) {
391 const auto oldConfig
392 = QSettings(QSettings::IniFormat, QSettings::UserScope, QCoreApplication::organizationName(), QCoreApplication::applicationName())
393 .fileName();
394 QFile::rename(oldConfig, settings->fileName()) || QFile::remove(oldConfig);
395 }
396 }
397 settings->sync();
398 return settings;
399}
400
404QString errorMessageForSettings(const QSettings &settings)
405{
406 auto errorMessage = QString();
407 switch (settings.status()) {
408 case QSettings::NoError:
409 return QString();
410 case QSettings::AccessError:
411 errorMessage = QCoreApplication::translate("QtUtilities", "unable to access file");
412 break;
413 case QSettings::FormatError:
414 errorMessage = QCoreApplication::translate("QtUtilities", "file has invalid format");
415 break;
416 default:
417 errorMessage = QCoreApplication::translate("QtUtilities", "unknown error");
418 }
419 return QCoreApplication::translate("QtUtilities", "Unable to sync settings from \"%1\": %2").arg(settings.fileName(), errorMessage);
420}
421
426{
427#ifdef Q_OS_ANDROID
428 // delete OpenGL pipeline cache under Android as it seems to break loading the app in certain cases
429 const auto cachePaths = QStandardPaths::standardLocations(QStandardPaths::CacheLocation);
430 for (const auto &cachePath : cachePaths) {
431 const auto cacheDir = QDir(cachePath);
432 const auto subdirs = cacheDir.entryList(QDir::Dirs | QDir::NoDotAndDotDot);
433 for (const auto &subdir : subdirs) {
434 if (subdir.startsWith(QLatin1String("qtpipelinecache"))) {
435 QFile::remove(cachePath % QChar('/') % subdir % QStringLiteral("/qqpc_opengl"));
436 }
437 }
438 }
439#endif
440}
441
442} // namespace QtUtilities
QT_UTILITIES_EXPORT bool hasCoreApp()
Returns whether a QCoreApplication has been instantiated yet.
Functions for using the resources provided by this library.
Definition resources.h:53
QT_UTILITIES_EXPORT void init()
Initiates the resources used and provided by this library.
Definition resources.cpp:55
QT_UTILITIES_EXPORT void cleanup()
Frees the resources used and provided by this library.
Definition resources.cpp:64
QT_UTILITIES_EXPORT void loadQtTranslationFile(std::initializer_list< QString > repositoryNames)
Loads and installs the appropriate Qt translation file for the current locale.
QT_UTILITIES_EXPORT void clearTranslationFiles()
Clears all translation files previously loaded via the load-functions in this namespace.
QT_UTILITIES_EXPORT void loadApplicationTranslationFile(const QString &configName, const QString &applicationName)
Loads and installs the appropriate application translation file for the current locale.
QT_UTILITIES_EXPORT QString & additionalTranslationFilePath()
Allows to set an additional search path for translation files.
Definition resources.cpp:84
QT_UTILITIES_EXPORT std::unique_ptr< QSettings > getSettings(const QString &organization, const QString &application=QString())
Returns the settings object for the specified organization and application.
QT_UTILITIES_EXPORT void deletePipelineCacheIfNeeded()
Deletes the Qt Quick pipeline cache on platforms where this is needed to workaround issues with the c...
QT_UTILITIES_EXPORT void setupCommonQtApplicationAttributes()
Sets Qt application attributes which are commonly used within my Qt applications.
QT_UTILITIES_EXPORT QString errorMessageForSettings(const QSettings &settings)
Returns an error message for the specified settings or an empty string if there's no error.