Translator.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
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.
 
Library: Base
File: Translator
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/String.h>
#include <NDEVR/INIFactory.h>
#include <NDEVR/File.h>
#include <NDEVR/Dictionary.h>
#include <NDEVR/INIInterface.h>
namespace NDEVR
{
    /**--------------------------------------------------------------------------------------------------
    \brief Contains logic for translating a string into a defined language
    **/
    class NDEVR_BASE_API Translator : public INIInterface
    {
    public:
        Translator();
        Translator(const String& translation_id);
        Translator(const File& settings_file);
        Translator(const Translator& translator);
        virtual String convertNumber(const String& number_string, bool add_comma, uint04 min_decimals, uint04 max_decimals, uint04 min_digits) const;
        virtual String convertText(const String& text_string) const;
        virtual String convertText(const String& text_string, const String& default_text) const;
        void copyFrom(const Translator& trans, bool use_existing_ini_file);
        void copyTranslationsFrom(const Translator& trans);
        File translatorFile(bool user_file) const;
        void getINI(INIFactory& factory) override;
        INIFactory& translationINI() const;
        static Dictionary<String, Translator> GetAvailableTranslations(File folder = File());
        const String& id() const { return m_translation_id; }
        const String& name() const { return m_language_name; }
        void setID(const String& id);
        bool isLeftToRight() const;
        void setName(const String& name);
        Translator& operator=(const Translator& translation);
        String commonCharacters() const;
        void saveTranslation(File location = File());
        File activeTranslatorFile() const;
        Dictionary<String, String> translatedStrings() const;
    public:
        static Translator* MainTranslator();
        static void SetMainTranslator(Translator* translator);
        static String DefaultLabel(const String& text_string);
    protected:
        void ensureLanguageLoaded() const;
        void init();
        mutable INIFactory m_language_ini;
        File m_translation_file;
        String m_language_name;
        String m_common_characters;
        String m_translation_id;
        mutable bool m_has_loaded_language;
        char m_number_sep;//typically ,
        char m_decimal_sep;//typically .
        bool m_left_to_right;//typically true
    public:
        static Resource<Translator*> main_translator;
    };
    //Translate string
    #define _t(english_string) (TranslatedString(Translator::DefaultLabel(english_string), english_string))
    //Translate number
    #define _tn(number_string, add_comma, min_decimals, max_decimals, min_digits) (Translator::MainTranslator()->convertNumber(number_string, add_comma, min_decimals, max_decimals, min_digits))
    //Translate string by description
    #define _td(def, english_string) (TranslatedString(Translator::DefaultLabel(def), english_string))
}