1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442
|
#include "./resources.h"
#include "resources/config.h"
#include <QDir>
#include <QFile>
#include <QFont>
#include <QIcon>
#include <QLibraryInfo>
#include <QLocale>
#include <QSettings>
#include <QString>
#include <QStringBuilder>
#include <QTranslator>
#if defined(QT_UTILITIES_GUI_QTWIDGETS)
#include <QApplication>
#elif defined(QT_UTILITIES_GUI_QTQUICK)
#include <QGuiApplication>
#else
#include <QCoreApplication>
#endif
#ifdef Q_OS_ANDROID
#include <QStandardPaths>
#endif
#include <iostream>
using namespace std;
///! \cond
inline void initResources()
{
Q_INIT_RESOURCE(qtutilsicons);
}
inline void cleanupResources()
{
Q_CLEANUP_RESOURCE(qtutilsicons);
}
///! \endcond
namespace QtUtilities {
/*!
* \brief Functions for using the resources provided by this library.
* \deprecated Replaced by ENABLE_QT_RESOURCES_OF_STATIC_DEPENDENCIES macro.
*/
namespace QtUtilitiesResources {
/*!
* \brief Initiates the resources used and provided by this library.
* \deprecated Replaced by ENABLE_QT_RESOURCES_OF_STATIC_DEPENDENCIES macro.
*/
void init()
{
initResources();
}
/*!
* \brief Frees the resources used and provided by this library.
* \deprecated Replaced by ENABLE_QT_RESOURCES_OF_STATIC_DEPENDENCIES macro.
*/
void cleanup()
{
cleanupResources();
}
} // namespace QtUtilitiesResources
/*!
* \brief Convenience functions to load translations for Qt and the application.
*/
namespace TranslationFiles {
/*!
* \brief The translators installed via the load-functions in this namespace.
*/
static QList<QTranslator *> translators;
/*!
* \brief Allows to set an additional search path for translation files.
* \remarks This path is considered *before* the default directories.
*/
QString &additionalTranslationFilePath()
{
static QString path;
return path;
}
/*!
* \brief Loads and installs the appropriate Qt translation file for the current
* locale.
* \param repositoryNames Specifies the names of the Qt repositories to load
* translations for (eg. qtbase, qtscript, ...).
* \remarks
* - Translation files have to be placed in one of the following locations:
* * QLibraryInfo::location(QLibraryInfo::TranslationsPath) (used in UNIX)
* * ../share/qt/translations (used in Windows)
* - Translation files can also be built-in using by setting the CMake variable
* BUILTIN_TRANSLATIONS.
* In this case it is also necessary to load the translations using this
* function.
*/
void loadQtTranslationFile(std::initializer_list<QString> repositoryNames)
{
loadQtTranslationFile(repositoryNames, QLocale().name());
}
/*!
* \brief Loads and installs the appropriate Qt translation file for the
* specified locale.
* \param repositoryNames Specifies the names of the Qt repositories to load
* translations for (eg. qtbase, qtscript, ...).
* \param localeName Specifies the name of the locale.
* \remarks
* - Translation files have to be placed in one of the following locations:
* * QLibraryInfo::location(QLibraryInfo::TranslationsPath) (used in UNIX)
* * ../share/qt/translations (used in Windows)
* - Translation files can also be built-in using by setting the CMake variable
* BUILTIN_TRANSLATIONS.
* In this case it is also necessary to load the translations using this
* function.
*/
void loadQtTranslationFile(initializer_list<QString> repositoryNames, const QString &localeName)
{
const auto debugTranslations = qEnvironmentVariableIsSet("QT_DEBUG_TRANSLATIONS");
for (const auto &repoName : repositoryNames) {
auto *const qtTranslator = new QTranslator(QCoreApplication::instance());
const auto fileName = QString(repoName % QChar('_') % localeName);
QString path;
if ((!additionalTranslationFilePath().isEmpty() && qtTranslator->load(fileName, path = additionalTranslationFilePath()))
|| qtTranslator->load(fileName,
path =
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
QLibraryInfo::location(QLibraryInfo::TranslationsPath)
#else
QLibraryInfo::path(QLibraryInfo::TranslationsPath)
#endif
)
|| qtTranslator->load(fileName, path = QStringLiteral("../share/qt/translations"))
|| qtTranslator->load(fileName, path = QStringLiteral(":/translations"))) {
QCoreApplication::installTranslator(qtTranslator);
translators.append(qtTranslator);
if (debugTranslations) {
cerr << "Loading translation file for Qt repository \"" << repoName.toLocal8Bit().data() << "\" and the locale \""
<< localeName.toLocal8Bit().data() << "\" from \"" << path.toLocal8Bit().data() << "\"." << endl;
}
} else {
delete qtTranslator;
if (localeName.startsWith(QLatin1String("en"))) {
// the translation file is probably just empty (English is built-in and usually only used for plural forms)
continue;
}
cerr << "Unable to load translation file for Qt repository \"" << repoName.toLocal8Bit().data() << "\" and locale "
<< localeName.toLocal8Bit().data() << "." << endl;
}
}
}
/*!
* \brief Loads and installs the appropriate application translation file for
* the current locale.
* \param applicationName Specifies the name of the application.
* \remarks
* - Translation files have to be placed in one of the following locations:
* * ./
* * ../$application
* * ../../$application
* * ./translations
* * ../share/$application/translations
* * $install_prefix/share/$application/translations
* - Translation files must be named using the following scheme:
* * $application_$language.qm
* - Translation files can also be built-in using by setting the CMake variable
* BUILTIN_TRANSLATIONS.
* In this case it is also necessary to load the translations using this
* function.
*/
void loadApplicationTranslationFile(const QString &configName, const QString &applicationName)
{
// load English translation files as fallback
loadApplicationTranslationFile(configName, applicationName, QStringLiteral("en_US"));
// load translation files for current locale
const auto defaultLocale(QLocale().name());
if (defaultLocale != QLatin1String("en_US")) {
loadApplicationTranslationFile(configName, applicationName, defaultLocale);
}
}
/// \cond
void logTranslationEvent(
const char *event, const QString &configName, const QString &applicationName, const QString &localeName, const QString &path = QString())
{
cerr << event << " translation file for \"" << applicationName.toLocal8Bit().data() << "\"";
if (!configName.isEmpty()) {
cerr << " (config \"" << configName.toLocal8Bit().data() << "\")";
}
cerr << " and locale \"" << localeName.toLocal8Bit().data() << '\"';
if (!path.isEmpty()) {
cerr << " from \"" << path.toLocal8Bit().data() << '\"';
}
cerr << '.' << endl;
}
/// \endcond
/*!
* \brief Loads and installs the appropriate application translation file for
* the specified locale.
* \param applicationName Specifies the name of the application.
* \param localeName Specifies the name of the locale.
* \remarks
* - Translation files have to be placed in one of the following locations:
* * ./
* * ../$application
* * ../../$application
* * ./translations
* * ../share/$application/translations
* * $install_prefix/share/$application/translations
* - Translation files must be named using the following scheme:
* * $application_$language.qm
* - Translation files can also be built-in using by setting the CMake variable
* BUILTIN_TRANSLATIONS.
* In this case it is also necessary to load the translations using this
* function.
*/
void loadApplicationTranslationFile(const QString &configName, const QString &applicationName, const QString &localeName)
{
auto *const appTranslator = new QTranslator(QCoreApplication::instance());
const auto fileName = QString(applicationName % QChar('_') % localeName);
const auto directoryName = configName.isEmpty() ? applicationName : QString(applicationName % QChar('-') % configName);
QString path;
if ((!additionalTranslationFilePath().isEmpty() && appTranslator->load(fileName, path = additionalTranslationFilePath()))
|| appTranslator->load(fileName, path = QStringLiteral(".")) || appTranslator->load(fileName, path = QStringLiteral("../") % directoryName)
|| appTranslator->load(fileName, path = QStringLiteral("../../") % directoryName)
|| appTranslator->load(fileName, path = QStringLiteral("./translations"))
|| appTranslator->load(fileName, path = QStringLiteral("../share/") % directoryName % QStringLiteral("/translations"))
|| appTranslator->load(fileName, path = QStringLiteral(APP_INSTALL_PREFIX "/share/") % directoryName % QStringLiteral("/translations"))
|| appTranslator->load(fileName, path = QStringLiteral(":/translations"))) {
QCoreApplication::installTranslator(appTranslator);
translators.append(appTranslator);
if (qEnvironmentVariableIsSet("QT_DEBUG_TRANSLATIONS")) {
logTranslationEvent("Loading", configName, applicationName, localeName, path);
}
} else {
delete appTranslator;
if (localeName.startsWith(QLatin1String("en"))) {
// the translation file is probably just empty (English is built-in and usually only used for plural forms)
return;
}
logTranslationEvent("Unable to load", configName, applicationName, localeName);
}
}
/*!
* \brief Loads and installs the appropriate application translation file for
* the current locale.
* \param applicationNames Specifies the names of the applications.
*/
void loadApplicationTranslationFile(const QString &configName, const std::initializer_list<QString> &applicationNames)
{
for (const QString &applicationName : applicationNames) {
loadApplicationTranslationFile(configName, applicationName);
}
}
/*!
* \brief Loads and installs the appropriate application translation file for
* the specified locale.
* \param applicationNames Specifies the names of the applications.
* \param localeName Specifies the name of the locale.
*/
void loadApplicationTranslationFile(const QString &configName, const std::initializer_list<QString> &applicationNames, const QString &localeName)
{
for (const QString &applicationName : applicationNames) {
loadApplicationTranslationFile(configName, applicationName, localeName);
}
}
/*!
* \brief Clears all translation files previously loaded via the load-functions in this namespace.
*/
void clearTranslationFiles()
{
for (auto *const translator : translators) {
QCoreApplication::removeTranslator(translator);
}
translators.clear();
}
} // namespace TranslationFiles
/*!
* \brief Convenience functions to check whether a
* QCoreApplication/QGuiApplication/QApplication singleton has been instantiated
* yet.
*/
namespace ApplicationInstances {
#if defined(QT_UTILITIES_GUI_QTWIDGETS)
/*!
* \brief Returns whether a QApplication has been instantiated yet.
*/
bool hasWidgetsApp()
{
return qobject_cast<QApplication *>(QCoreApplication::instance()) != nullptr;
}
#endif
#if defined(QT_UTILITIES_GUI_QTWIDGETS) || defined(QT_UTILITIES_GUI_QTQUICK)
/*!
* \brief Returns whether a QGuiApplication has been instantiated yet.
*/
bool hasGuiApp()
{
return qobject_cast<QGuiApplication *>(QCoreApplication::instance()) != nullptr;
}
#endif
/*!
* \brief Returns whether a QCoreApplication has been instantiated yet.
*/
bool hasCoreApp()
{
return qobject_cast<QCoreApplication *>(QCoreApplication::instance()) != nullptr;
}
} // namespace ApplicationInstances
/*!
* \brief Sets Qt application attributes which are commonly used within my Qt applications.
* \remarks
* - So far this enables High-DPI support.
* - The exact attributes are unspecified and might change to whatever makes sense in the future.
*/
void setupCommonQtApplicationAttributes()
{
// enable dark window frame on Windows if the configured color palette is dark
// - supported as of Qt 6.4; no longer required as of Qt 6.5
// - see https://bugreports.qt.io/browse/QTBUG-72028?focusedCommentId=677819#comment-677819
// and https://www.qt.io/blog/dark-mode-on-windows-11-with-qt-6.5
#if defined(Q_OS_WINDOWS) && (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0)) && (QT_VERSION < QT_VERSION_CHECK(6, 5, 0))
if (const auto qtVersion = QLibraryInfo::version();
qtVersion >= QVersionNumber(6, 4, 0) && qtVersion < QVersionNumber(6, 5, 0) && !qEnvironmentVariableIsSet("QT_QPA_PLATFORM")) {
qputenv("QT_QPA_PLATFORM", "windows:darkmode=1");
}
#endif
// ensure FONTCONFIG_PATH is set (mainly required for static GNU/Linux builds)
#ifdef QT_FEATURE_fontdialog
if (!qEnvironmentVariableIsSet("FONTCONFIG_PATH") && QDir(QStringLiteral("/etc/fonts")).exists()) {
qputenv("FONTCONFIG_PATH", "/etc/fonts");
}
#endif
// enable settings for High-DPI scaling
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
if (!QCoreApplication::instance()) {
QCoreApplication::setAttribute(Qt::AA_EnableHighDpiScaling, true);
}
QCoreApplication::setAttribute(Qt::AA_UseHighDpiPixmaps, true);
#endif
}
/*!
* \brief Returns the settings object for the specified \a organization and \a application.
* \remarks
* - This function always uses INI as that's what I'd like to use in all of my applications consistently, regardless of the platform.
* - The parameter \a application might be empty. In fact, most of my applications use just `getSettings(QStringLiteral(PROJECT_NAME))`.
* - This function first checks whether a file called `$organization/$application.ini` exists in the current working directory or next
* to the executable (or just `$organization.ini` if \a application is empty) and uses that if it exists. That allows having a portable
* installation.
* - Some of my apps where using values from QCoreApplication for \a organization and \a application in the beginning. This function
* moves those old config files to their new location if needed. This extra handling will likely removed at some point. Note that
* I moved away from using values from QCoreApplication to avoid having spaces and additional config suffixes in the file name.
*/
std::unique_ptr<QSettings> getSettings(const QString &organization, const QString &application)
{
auto settings = std::unique_ptr<QSettings>();
const auto portableFileName
= application.isEmpty() ? organization + QStringLiteral(".ini") : organization % QChar('/') % application % QStringLiteral(".ini");
if (const auto portableFileWorkingDir = QFile(portableFileName); portableFileWorkingDir.exists()) {
settings = std::make_unique<QSettings>(portableFileWorkingDir.fileName(), QSettings::IniFormat);
} else if (const auto portableFileNextToApp = QFile(QCoreApplication::applicationDirPath() % QChar('/') % portableFileName);
portableFileNextToApp.exists()) {
settings = std::make_unique<QSettings>(portableFileNextToApp.fileName(), QSettings::IniFormat);
} else {
settings = std::make_unique<QSettings>(QSettings::IniFormat, QSettings::UserScope, organization, application);
// move config created by older versions to new location
if (organization != QCoreApplication::organizationName() || application != QCoreApplication::applicationName()) {
const auto oldConfig
= QSettings(QSettings::IniFormat, QSettings::UserScope, QCoreApplication::organizationName(), QCoreApplication::applicationName())
.fileName();
QFile::rename(oldConfig, settings->fileName()) || QFile::remove(oldConfig);
}
}
settings->sync();
return settings;
}
/*!
* \brief Returns an error message for the specified \a settings or an empty string if there's no error.
*/
QString errorMessageForSettings(const QSettings &settings)
{
auto errorMessage = QString();
switch (settings.status()) {
case QSettings::NoError:
return QString();
case QSettings::AccessError:
errorMessage = QCoreApplication::translate("QtUtilities", "unable to access file");
break;
case QSettings::FormatError:
errorMessage = QCoreApplication::translate("QtUtilities", "file has invalid format");
break;
default:
errorMessage = QCoreApplication::translate("QtUtilities", "unknown error");
}
return QCoreApplication::translate("QtUtilities", "Unable to sync settings from \"%1\": %2").arg(settings.fileName(), errorMessage);
}
/*!
* \brief Deletes the Qt Quick pipeline cache on platforms where this is needed to workaround issues with the cache.
*/
void deletePipelineCacheIfNeeded()
{
#ifdef Q_OS_ANDROID
// delete OpenGL pipeline cache under Android as it seems to break loading the app in certain cases
const auto cachePaths = QStandardPaths::standardLocations(QStandardPaths::CacheLocation);
for (const auto &cachePath : cachePaths) {
const auto cacheDir = QDir(cachePath);
const auto subdirs = cacheDir.entryList(QDir::Dirs | QDir::NoDotAndDotDot);
for (const auto &subdir : subdirs) {
if (subdir.startsWith(QLatin1String("qtpipelinecache"))) {
QFile::remove(cachePath % QChar('/') % subdir % QStringLiteral("/qqpc_opengl"));
}
}
}
#endif
}
} // namespace QtUtilities
|