TranslationLookup.h

#pragma once
 
#include <Foundation/Basics.h>
#include <Foundation/Containers/DynamicArray.h>
#include <Foundation/Containers/Map.h>
#include <Foundation/Strings/String.h>
#include <Foundation/Types/UniquePtr.h>
 
enum class plTranslationUsage
{
  Default,
  Tooltip,
  HelpURL,
 
  ENUM_COUNT
};
 
class PL_FOUNDATION_DLL plTranslator
{
public:
  plTranslator();
  virtual ~plTranslator();
 
  virtual plStringView Translate(plStringView sString, plUInt64 uiStringHash, plTranslationUsage usage) = 0;
 
  virtual void Reset();
 
  virtual void Reload();
 
  static void ReloadAllTranslators();
 
  static void HighlightUntranslated(bool bHighlight);
 
  static bool GetHighlightUntranslated() { return s_bHighlightUntranslated; }
 
private:
  static bool s_bHighlightUntranslated;
  static plHybridArray<plTranslator*, 4> s_AllTranslators;
};
 
class PL_FOUNDATION_DLL plTranslatorPassThrough : public plTranslator
{
public:
  virtual plStringView Translate(plStringView sString, plUInt64 uiStringHash, plTranslationUsage usage) override { return sString; }
};
 
class PL_FOUNDATION_DLL plTranslatorStorage : public plTranslator
{
public:
  virtual void StoreTranslation(plStringView sString, plUInt64 uiStringHash, plTranslationUsage usage);
 
  virtual plStringView Translate(plStringView sString, plUInt64 uiStringHash, plTranslationUsage usage) override;
 
  virtual void Reset() override;
 
  virtual void Reload() override;
 
protected:
  plMap<plUInt64, plString> m_Translations[(int)plTranslationUsage::ENUM_COUNT];
};
 
class PL_FOUNDATION_DLL plTranslatorLogMissing : public plTranslatorStorage
{
public:
  static bool s_bActive;
 
  virtual plStringView Translate(plStringView sString, plUInt64 uiStringHash, plTranslationUsage usage) override;
};
 
class PL_FOUNDATION_DLL plTranslatorFromFiles : public plTranslatorStorage
{
public:
  void AddTranslationFilesFromFolder(const char* szFolder);
 
  virtual plStringView Translate(plStringView sString, plUInt64 uiStringHash, plTranslationUsage usage) override;
 
  virtual void Reload() override;
 
private:
  void LoadTranslationFile(const char* szFullPath);
 
  plHybridArray<plString, 4> m_Folders;
};
 
class PL_FOUNDATION_DLL plTranslatorMakeMoreReadable : public plTranslatorStorage
{
public:
  virtual plStringView Translate(plStringView sString, plUInt64 uiStringHash, plTranslationUsage usage) override;
};
 
class PL_FOUNDATION_DLL plTranslationLookup
{
public:
  static void AddTranslator(plUniquePtr<plTranslator> pTranslator);
 
  static plStringView Translate(plStringView sString, plUInt64 uiStringHash, plTranslationUsage usage);
 
  static void Clear();
 
private:
  static plHybridArray<plUniquePtr<plTranslator>, 16> s_Translators;
};
 
#define plTranslate(string) plTranslationLookup::Translate(string, plHashingUtils::StringHash(string), plTranslationUsage::Default)
 
#define plTranslateTooltip(string) plTranslationLookup::Translate(string, plHashingUtils::StringHash(string), plTranslationUsage::Tooltip)
 
#define plTranslateHelpURL(string) plTranslationLookup::Translate(string, plHashingUtils::StringHash(string), plTranslationUsage::HelpURL)