resources.cpp

Go to the documentation of this file.

#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 <QDebug>
#include <QStandardPaths>
#endif
 
#ifdef Q_OS_ANDROID
#include <c++utilities/conversion/stringbuilder.h>
#endif
 
#include <iostream>
 
using namespace std;

inline void initResources()
{
    Q_INIT_RESOURCE(qtutilsicons);
}
 
inline void cleanupResources()
{
    Q_CLEANUP_RESOURCE(qtutilsicons);
}
 
namespace QtUtilities {

namespace QtUtilitiesResources {

void init()
{
    initResources();
}

void cleanup()
{
    cleanupResources();
}
} // namespace QtUtilitiesResources

namespace TranslationFiles {

static QList<QTranslator *> translators;

QString &additionalTranslationFilePath()
{
    static QString path;
    return path;
}

static QString relativeBase()
{
    static const auto relativeBase = [] {
        auto appDir = QCoreApplication::applicationDirPath();
        if (appDir.isEmpty()) {
            appDir = QStringLiteral(".");
        }
        return appDir;
    }();
    return relativeBase;
}

void loadQtTranslationFile(std::initializer_list<QString> repositoryNames)
{
    loadQtTranslationFile(repositoryNames, QLocale().name());
}

void loadQtTranslationFile(initializer_list<QString> repositoryNames, const QString &localeName)
{
    const auto debugTranslations = qEnvironmentVariableIntValue("QT_DEBUG_TRANSLATIONS");
    const auto relBase = relativeBase();
    for (const auto &repoName : repositoryNames) {
        auto *const qtTranslator = new QTranslator(QCoreApplication::instance());
        const auto fileName = QString(repoName % QChar('_') % localeName);
 
        QString path;
        if (
            // allow putting translations into configurable directory
            (!additionalTranslationFilePath().isEmpty() && qtTranslator->load(fileName, path = additionalTranslationFilePath()))
            // allow putting translations next to the Qt libraries
            || qtTranslator->load(fileName,
                path =
#if (QT_VERSION < QT_VERSION_CHECK(6, 0, 0))
                    QLibraryInfo::location(QLibraryInfo::TranslationsPath)
#else
                    QLibraryInfo::path(QLibraryInfo::TranslationsPath)
#endif
                    )
            // load translations from the "share" directory to support installations following the usual UNIX file system hierarchy
            || qtTranslator->load(fileName, path = relBase + QStringLiteral("/../share/qt/translations"))
            // load built-in 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;
            }
#if defined(Q_OS_ANDROID)
            qDebug() << "Unable to load translation file for Qt repository: " << repoName << localeName;
#else
            cerr << "Unable to load translation file for Qt repository \"" << repoName.toLocal8Bit().data() << "\" and locale "
                 << localeName.toLocal8Bit().data() << "." << endl;
#endif
        }
    }
}

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);
    }
}

static void logTranslationEvent(
    const char *event, const QString &configName, const QString &applicationName, const QString &localeName, const QString &path = QString())
{
#if defined(Q_OS_ANDROID)
    qDebug() << CppUtilities::argsToString(event, " translation file for: ").data() << applicationName << localeName;
    if (!configName.isEmpty()) {
        qDebug() << "config: " << configName;
    }
    if (!path.isEmpty()) {
        qDebug() << "path: " << path;
    }
#else
    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;
#endif
}

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);
    const auto relBase = relativeBase();
 
    if (auto path = QString();
        // allow putting translations into configurable directory
        (!additionalTranslationFilePath().isEmpty() && appTranslator->load(fileName, path = additionalTranslationFilePath()))
        // allow putting translations next to the executable (useful during development and for easily supplying additional
        // translations, e.g. under Windows)
        || appTranslator->load(fileName, path = relBase)
        // load translations from sibling directories (useful during development to load translations of e.g. qtutilities
        // from its build directory)
        || appTranslator->load(fileName, path = relBase % QStringLiteral("/../") % applicationName)
        || appTranslator->load(fileName, path = relBase % QStringLiteral("/../../") % applicationName)
        // allow putting translations next to the executable into "translations" subdirectory (useful for easily supplying
        // additional translations, e.g. under Windows)
        || appTranslator->load(fileName, path = relBase % QStringLiteral("/translations"))
        // load translations from the "share" directory to support installations following the usual UNIX file system hierarchy
        || appTranslator->load(fileName, path = relBase % QStringLiteral("/../share/") % directoryName % QStringLiteral("/translations"))
        || appTranslator->load(fileName, path = QStringLiteral(APP_INSTALL_PREFIX "/share/") % directoryName % QStringLiteral("/translations"))
        // load built-in translations
        || appTranslator->load(fileName, path = QStringLiteral(":/translations"))) {
        QCoreApplication::installTranslator(appTranslator);
        translators.append(appTranslator);
        if (qEnvironmentVariableIntValue("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);
    }
}

void loadApplicationTranslationFile(const QString &configName, const std::initializer_list<QString> &applicationNames)
{
    for (const QString &applicationName : applicationNames) {
        loadApplicationTranslationFile(configName, applicationName);
    }
}

void loadApplicationTranslationFile(const QString &configName, const std::initializer_list<QString> &applicationNames, const QString &localeName)
{
    for (const QString &applicationName : applicationNames) {
        loadApplicationTranslationFile(configName, applicationName, localeName);
    }
}

void clearTranslationFiles()
{
    for (auto *const translator : translators) {
        QCoreApplication::removeTranslator(translator);
    }
    translators.clear();
}
 
} // namespace TranslationFiles

namespace ApplicationInstances {
 
#if defined(QT_UTILITIES_GUI_QTWIDGETS)
bool hasWidgetsApp()
{
    return qobject_cast<QApplication *>(QCoreApplication::instance()) != nullptr;
}
#endif
 
#if defined(QT_UTILITIES_GUI_QTWIDGETS) || defined(QT_UTILITIES_GUI_QTQUICK)
bool hasGuiApp()
{
    return qobject_cast<QGuiApplication *>(QCoreApplication::instance()) != nullptr;
}
#endif

bool hasCoreApp()
{
    return qobject_cast<QCoreApplication *>(QCoreApplication::instance()) != nullptr;
}
} // namespace ApplicationInstances

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
}

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);
        }
    }
    loadSettingsWithLogging(*settings);
    return settings;
}

void loadSettingsWithLogging(QSettings &settings)
{
    settings.sync();
    if (!qEnvironmentVariableIntValue("QT_DEBUG_SETTINGS")) {
        return;
    }
    const auto error = errorMessageForSettings(settings);
    if (error.isEmpty()) {
        std::cerr << "Loaded/synced settings from " << settings.fileName().toStdString() << '\n';
    } else {
        std::cerr << "Unable to load settings: " << error.toStdString() << '\n';
    }
}

void saveSettingsWithLogging(QSettings &settings)
{
    settings.sync();
    if (!qEnvironmentVariableIntValue("QT_DEBUG_SETTINGS")) {
        return;
    }
    const auto error = errorMessageForSettings(settings);
    if (error.isEmpty()) {
        std::cerr << "Saved/synced settings to " << settings.fileName().toStdString() << '\n';
    } else {
        std::cerr << "Unable to save settings: " << error.toStdString() << '\n';
    }
}

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);
}

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