TranslatedString.h

Go to the documentation of this file.

#pragma once
#include "DLLInfo.h"
#include <NDEVR/String.h>
#include <NDEVR/Dictionary.h>
namespace NDEVR
{
    class TranslatedString;
    /**--------------------------------------------------------------------------------------------------
    \brief Any text displayed to the user should be defined as a TranslatedString which allows the 
        program to look up a translation, if available.
    **/
    class TranslatedString
    {
    public:
        NDEVR_BASE_API TranslatedString();
        ~TranslatedString()
        {
            for (auto& iter : m_replacements)
                delete iter.second;
        }
        NDEVR_BASE_API TranslatedString(const TranslatedString& translation);
        NDEVR_BASE_API TranslatedString(TranslatedString&& translation) noexcept;
        NDEVR_BASE_API explicit TranslatedString(const char* const raw_string);
        NDEVR_BASE_API explicit TranslatedString(const String& raw_string);
        NDEVR_BASE_API TranslatedString(const String& translation_id, const String& english);
        NDEVR_BASE_API void retranslate();
        NDEVR_BASE_API const String& translation() const;
        NDEVR_BASE_API String translation(const String& translation_id) const;
        NDEVR_BASE_API const String& translationID() const;
        NDEVR_BASE_API TranslatedString& replace(const String& sub_string, const TranslatedString& replacement);
        NDEVR_BASE_API TranslatedString& replace(const String& sub_string, const String& replacement);
        NDEVR_BASE_API bool isTranslatable() const;
        NDEVR_BASE_API bool hasReplacements() const;
        NDEVR_BASE_API bool isEmpty() const;
        NDEVR_BASE_API const String& englishTranslation() const;
        NDEVR_BASE_API String internalValue() const;
        NDEVR_BASE_API TranslatedString& operator=(TranslatedString&& translation) noexcept;
        NDEVR_BASE_API TranslatedString& operator=(const TranslatedString& translation) noexcept;
        NDEVR_BASE_API bool operator!=(const TranslatedString& translation) const;
        NDEVR_BASE_API bool operator==(const TranslatedString& translation) const;
        NDEVR_BASE_API bool operator<(const TranslatedString& value) const;
        NDEVR_BASE_API bool operator>(const TranslatedString& value) const;
    protected:
        void calculateEnglishString();
        //operator+=()
    protected:
        Dictionary<String, TranslatedString*> m_replacements;
        mutable String m_translation_id;
        mutable String m_english_string;
        mutable String m_translation;
        mutable bool m_is_translated;
    };
    template<class t_type>
    TranslatedString String::DisplayString(const t_type& value)
    {
        TranslatedString s;
        StringStream<t_type>::toDisplayString(value, s);
        return s;
    }
    template<> inline const TranslatedString Constant<TranslatedString>::Invalid = TranslatedString();
}
 
namespace std//Define things to allow use within std libs
{
    template <>
    struct hash<NDEVR::TranslatedString>
    {
        std::size_t operator()(const NDEVR::TranslatedString& s) const noexcept
        {
            return static_cast<size_t>(s.translationID().hash());
        }
    };
};