Internationalizer.hpp

#ifndef H_EXTENSIONS_CUTEHMI_2_INCLUDE_CUTEHMI_INTERNATIONALIZER_HPP
#define H_EXTENSIONS_CUTEHMI_2_INCLUDE_CUTEHMI_INTERNATIONALIZER_HPP
 
#include "internal/common.hpp"
#include "Singleton.hpp"
 
#include <QObject>
#include <QMap>
#include <QTranslator>
 
namespace cutehmi {
 
class CUTEHMI_API Internationalizer:
    public QObject,
    public Singleton<Internationalizer>
{
        Q_OBJECT
        //<CuteHMI.Workarounds.Qt5Compatibility-4.workaround target="Qt" cause="Qt5.15-QML_SINGLETON">
#if (QT_VERSION >= QT_VERSION_CHECK(6, 0, 0))
        QML_NAMED_ELEMENT(Internationalizer)
        QML_UNCREATABLE("Internationalizer is a singleton")
        QML_SINGLETON
#endif
        //</CuteHMI.Workarounds.Qt5Compatibility-4.workaround>
 
        friend class Singleton<Internationalizer>;
        friend class test_Internationalizer;
 
    public:
        Q_PROPERTY(QString uiLanguage READ uiLanguage WRITE setUILanguage NOTIFY uiLanguageChanged)
 
        
        static Internationalizer * create(QQmlEngine * qmlEngine, QJSEngine * jsEngine);
 
        QString uiLanguage() const;
 
        void setUILanguage(const QString & uiLanguage);
 
        Q_INVOKABLE void loadQtTranslation();
 
        Q_INVOKABLE void unloadQtTranslation();
 
        Q_INVOKABLE void loadTranslation(const QString & product, bool dependencies = true);
 
        Q_INVOKABLE void unloadTranslation(const QString & product);
 
        Q_INVOKABLE void unloadTranslations(bool qt = true);
 
        Q_INVOKABLE QStringList standardTranslationDirectories() const;
 
        Q_INVOKABLE QStringList additionalTranslationDirectories() const;
 
        Q_INVOKABLE void setAdditionalTranslationDirectories(const QStringList & additionalDirectories);
 
    signals:
        void uiLanguageChanged();
 
    private:
        typedef QMap<QString, QTranslator *> TranslatorsContainer;
 
        explicit Internationalizer(QObject * parent = nullptr);
 
        void loadTranslation(QStringList & skippedProducts, const QString & product, bool dependencies);
 
        void updateTranslation(QTranslator & translator, const QString & product, const QStringList & directories);
 
        void updateQtTranslation(QTranslator & translator);
 
        QString translationFileStem(const QString & product);
 
        QStringList translationDirectories() const;
 
        struct Members
        {
            QLocale uiLanguage;
            TranslatorsContainer translators;
            QTranslator * qtTranslator = nullptr;
            QStringList additionalTranslationDirectories;
        };
 
        MPtr<Members> m;
};
 
}
 
#endif
 
//(c)C: Copyright © 2020-2022, Michał Policht <michal@policht.pl>. All rights reserved.
//(c)C: SPDX-License-Identifier: LGPL-3.0-or-later OR MIT
//(c)C: This file is a part of CuteHMI.
//(c)C: CuteHMI is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.
//(c)C: CuteHMI is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License for more details.
//(c)C: You should have received a copy of the GNU Lesser General Public License along with CuteHMI.  If not, see <https://www.gnu.org/licenses/>.
//(c)C: Additionally, this file is licensed under terms of MIT license as expressed below.
//(c)C: Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
//(c)C: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
//(c)C: THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.