xbmc/LangInfo.h

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #pragma once
  10
  11 #include "settings/lib/ISettingCallback.h"
  12 #include "settings/lib/ISettingsHandler.h"
  13 #include "utils/GlobalsHandling.h"
  14 #include "utils/Locale.h"
  15 #include "utils/Speed.h"
  16 #include "utils/Temperature.h"
  17
  18 #include <locale>
  19 #include <map>
  20 #include <memory>
  21 #include <set>
  22 #include <string>
  23 #include <utility>
  24 #include <vector>
  25
  26 #ifdef TARGET_WINDOWS
  27 #ifdef GetDateFormat
  28 #undef GetDateFormat
  29 #endif // GetDateFormat
  30 #ifdef GetTimeFormat
  31 #undef GetTimeFormat
  32 #endif // GetTimeFormat
  33 #endif // TARGET_WINDOWS
  34
  35 class TiXmlNode;
  36 struct StringSettingOption;
  37
  38 namespace ADDON
  39 {
  40   class CLanguageResource;
  41 }
  42 typedef std::shared_ptr<ADDON::CLanguageResource> LanguageResourcePtr;
  43
  44 enum class MeridiemSymbol
  45 {
  46   PM = 0,
  47   AM
  48 };
  49
  50 class CLangInfo : public ISettingCallback, public ISettingsHandler
  51 {
  52 public:
  53   CLangInfo();
  54   ~CLangInfo() override;
  55
  56   // implementation of ISettingCallback
  57   void OnSettingChanged(const std::shared_ptr<const CSetting>& setting) override;
  58
  59   // implementation of ISettingsHandler
  60   void OnSettingsLoaded() override;
  61
  62   /*
  63    * \brief Get language codes list of the installed language addons.
  64    * \param languages [OUT] The list of languages (language code, name).
  65    */
  66   static void GetAddonsLanguageCodes(std::map<std::string, std::string>& languages);
  67
  68   /*!
  69    \brief Returns the language addon for the given locale (or the current one).
  70
  71    \param locale (optional) Locale of the language (current if empty)
  72    \return Language addon for the given locale or NULL if the locale is invalid.
  73    */
  74   LanguageResourcePtr GetLanguageAddon(const std::string& locale = "") const;
  75
  76   std::string GetGuiCharSet() const;
  77   std::string GetSubtitleCharSet() const;
  78
  79   // three char language code (not win32 specific)
  80   const std::string& GetLanguageCode() const { return m_languageCodeGeneral; }
  81
  82   /*!
  83    * \brief Convert an english language name to an addon locale,
  84    *        by searching in the installed language addons.
  85    * \param langName [IN] The english language name
  86    * \return The locale for the given english name, or empty if not found
  87    */
  88   static std::string ConvertEnglishNameToAddonLocale(const std::string& langName);
  89
  90   /*!
  91    * \brief Get the english language name from given locale,
  92    *        by searching in the installed language addons.
  93    * \param locale [OPT] Locale of the language (current if empty)
  94    */
  95   std::string GetEnglishLanguageName(const std::string& locale = "") const;
  96
  97   /*!
  98   \brief Sets and loads the given (or configured) language, its details and strings.
  99
 100   \param strLanguage (optional) Language to be loaded.
 101   \param reloadServices (optional) Whether to reload services relying on localization.
 102   \return True if the language has been successfully loaded, false otherwise.
 103   */
 104   bool SetLanguage(std::string strLanguage = "", bool reloadServices = true);
 105
 106   /*
 107    * \brief Get the audio language in ISO 639-2 format.
 108    * \param allowFallback If set to true, when audio language setting is set to "default", "original" or "mediadefault"
 109    *                      the returned value can fallback to a general language code (e.g. eng), otherwise an empty value is returned.
 110    * \return The language code (user-defined also allowed). The value can be empty when allowFallback if set to false.
 111    */
 112   const std::string& GetAudioLanguage(bool allowFallback) const;
 113
 114   /*
 115    * \brief Set the audio language.
 116    * \param language The language can either be a two char language code,
 117    *        or a three char language code, or a language name in english,
 118    *        also user-defined languages are allowed.
 119    * \param isIso6392 Defines that language is in ISO 639-2 format, otherwise will be considered as ISO 639-1 format.
 120    */
 121   void SetAudioLanguage(const std::string& language, bool isIso6392 = false);
 122
 123   /*
 124    * \brief Get the subtitle language in ISO 639-2 format.
 125    * \param allowFallback If set to true, when audio language setting is set to "default", "original"
 126    *                      the returned value can fallback to a general language code (e.g. eng), otherwise an empty value is returned.
 127    * \return The language code (user-defined also allowed). The value can be empty when allowFallback if set to false.
 128    */
 129   const std::string& GetSubtitleLanguage(bool allowFallback) const;
 130
 131   /*
 132    * \brief Set the subtitle language.
 133    * \param language The language can either be a two char language code,
 134    *        or a three char language code, or a language name in english,
 135    *        also user-defined languages are allowed.
 136    * \param isIso6392 Defines that language is in ISO 639-2 format, otherwise will be considered as ISO 639-1 format.
 137    */
 138   void SetSubtitleLanguage(const std::string& language, bool isIso6392 = false);
 139
 140   const std::string GetDVDMenuLanguage() const;
 141   const std::string GetDVDAudioLanguage() const;
 142   const std::string GetDVDSubtitleLanguage() const;
 143   const std::string& GetTimeZone() const;
 144
 145   const std::string& GetRegionLocale() const;
 146
 147   const std::locale& GetOriginalLocale() const;
 148
 149   /*!
 150   \brief Returns the full locale of the current language.
 151   */
 152   const CLocale& GetLocale() const;
 153
 154   /*!
 155    \brief Returns the system's current locale.
 156    */
 157   const std::locale& GetSystemLocale() const { return m_systemLocale; }
 158
 159   bool ForceUnicodeFont() const { return m_forceUnicodeFont; }
 160
 161   const std::string& GetDateFormat(bool bLongDate = false) const;
 162   void SetDateFormat(const std::string& dateFormat, bool bLongDate = false);
 163   const std::string& GetShortDateFormat() const;
 164   void SetShortDateFormat(const std::string& shortDateFormat);
 165   const std::string& GetLongDateFormat() const;
 166   void SetLongDateFormat(const std::string& longDateFormat);
 167
 168   const std::string& GetTimeFormat() const;
 169   void SetTimeFormat(const std::string& timeFormat);
 170   bool Use24HourClock() const;
 171   void Set24HourClock(bool use24HourClock);
 172   void Set24HourClock(const std::string& str24HourClock);
 173   const std::string& GetMeridiemSymbol(MeridiemSymbol symbol) const;
 174   static const std::string& MeridiemSymbolToString(MeridiemSymbol symbol);
 175
 176   CTemperature::Unit GetTemperatureUnit() const;
 177   void SetTemperatureUnit(CTemperature::Unit temperatureUnit);
 178   void SetTemperatureUnit(const std::string& temperatureUnit);
 179   const std::string& GetTemperatureUnitString() const;
 180   static const std::string& GetTemperatureUnitString(CTemperature::Unit temperatureUnit);
 181   std::string GetTemperatureAsString(const CTemperature& temperature) const;
 182
 183   CSpeed::Unit GetSpeedUnit() const;
 184   void SetSpeedUnit(CSpeed::Unit speedUnit);
 185   void SetSpeedUnit(const std::string& speedUnit);
 186   const std::string& GetSpeedUnitString() const;
 187   static const std::string& GetSpeedUnitString(CSpeed::Unit speedUnit);
 188   std::string GetSpeedAsString(const CSpeed& speed) const;
 189
 190   void GetRegionNames(std::vector<std::string>& array);
 191   void SetCurrentRegion(const std::string& strName);
 192   const std::string& GetCurrentRegion() const;
 193
 194   std::set<std::string> GetSortTokens() const;
 195
 196   static std::string GetLanguagePath() { return "resource://"; }
 197   static std::string GetLanguagePath(const std::string &language);
 198   static std::string GetLanguageInfoPath(const std::string &language);
 199   bool UseLocaleCollation();
 200
 201   static void LoadTokens(const TiXmlNode* pTokens, std::set<std::string>& vecTokens);
 202
 203   static void SettingOptionsLanguageNamesFiller(const std::shared_ptr<const CSetting>& setting,
 204                                                 std::vector<StringSettingOption>& list,
 205                                                 std::string& current,
 206                                                 void* data);
 207   static void SettingOptionsAudioStreamLanguagesFiller(
 208       const std::shared_ptr<const CSetting>& setting,
 209       std::vector<StringSettingOption>& list,
 210       std::string& current,
 211       void* data);
 212   static void SettingOptionsSubtitleStreamLanguagesFiller(
 213       const std::shared_ptr<const CSetting>& setting,
 214       std::vector<StringSettingOption>& list,
 215       std::string& current,
 216       void* data);
 217   static void SettingOptionsSubtitleDownloadlanguagesFiller(
 218       const std::shared_ptr<const CSetting>& setting,
 219       std::vector<StringSettingOption>& list,
 220       std::string& current,
 221       void* data);
 222   static void SettingOptionsISO6391LanguagesFiller(const std::shared_ptr<const CSetting>& setting,
 223                                                    std::vector<StringSettingOption>& list,
 224                                                    std::string& current,
 225                                                    void* data);
 226   static void SettingOptionsRegionsFiller(const std::shared_ptr<const CSetting>& setting,
 227                                           std::vector<StringSettingOption>& list,
 228                                           std::string& current,
 229                                           void* data);
 230   static void SettingOptionsShortDateFormatsFiller(const std::shared_ptr<const CSetting>& setting,
 231                                                    std::vector<StringSettingOption>& list,
 232                                                    std::string& current,
 233                                                    void* data);
 234   static void SettingOptionsLongDateFormatsFiller(const std::shared_ptr<const CSetting>& setting,
 235                                                   std::vector<StringSettingOption>& list,
 236                                                   std::string& current,
 237                                                   void* data);
 238   static void SettingOptionsTimeFormatsFiller(const std::shared_ptr<const CSetting>& setting,
 239                                               std::vector<StringSettingOption>& list,
 240                                               std::string& current,
 241                                               void* data);
 242   static void SettingOptions24HourClockFormatsFiller(const std::shared_ptr<const CSetting>& setting,
 243                                                      std::vector<StringSettingOption>& list,
 244                                                      std::string& current,
 245                                                      void* data);
 246   static void SettingOptionsTemperatureUnitsFiller(const std::shared_ptr<const CSetting>& setting,
 247                                                    std::vector<StringSettingOption>& list,
 248                                                    std::string& current,
 249                                                    void* data);
 250   static void SettingOptionsSpeedUnitsFiller(const std::shared_ptr<const CSetting>& setting,
 251                                              std::vector<StringSettingOption>& list,
 252                                              std::string& current,
 253                                              void* data);
 254
 255 protected:
 256   void SetDefaults();
 257   bool Load(const std::string& strLanguage);
 258
 259   static bool DetermineUse24HourClockFromTimeFormat(const std::string& timeFormat);
 260   static bool DetermineUseMeridiemFromTimeFormat(const std::string& timeFormat);
 261   static std::string PrepareTimeFormat(const std::string& timeFormat, bool use24HourClock);
 262   static void AddLanguages(std::vector<StringSettingOption> &list);
 263
 264   class CRegion final
 265   {
 266   public:
 267     CRegion();
 268     void SetDefaults();
 269     void SetTemperatureUnit(const std::string& strUnit);
 270     void SetSpeedUnit(const std::string& strUnit);
 271     void SetTimeZone(const std::string& strTimeZone);
 272
 273     class custom_numpunct : public std::numpunct<char>
 274     {
 275     public:
 276       custom_numpunct(const char decimal_point, const char thousands_sep, const std::string& grouping)
 277         : cDecimalPoint(decimal_point), cThousandsSep(thousands_sep), sGroup(grouping) {}
 278     protected:
 279       char do_decimal_point() const override { return cDecimalPoint; }
 280       char do_thousands_sep() const override { return cThousandsSep; }
 281       std::string do_grouping() const override { return sGroup; }
 282     private:
 283       const char cDecimalPoint;
 284       const char cThousandsSep;
 285       const std::string sGroup;
 286     };
 287
 288     /*! \brief Set the locale associated with this region global.
 289
 290     Set the locale associated with this region global. This affects string
 291     sorting & transformations.
 292     */
 293     void SetGlobalLocale();
 294     std::string m_strLangLocaleName;
 295     std::string m_strLangLocaleCodeTwoChar;
 296     std::string m_strRegionLocaleName;
 297     std::string m_strName;
 298     std::string m_strDateFormatLong;
 299     std::string m_strDateFormatShort;
 300     std::string m_strTimeFormat;
 301     std::string m_strMeridiemSymbols[2];
 302     std::string m_strTimeZone;
 303     std::string m_strGrouping;
 304     char m_cDecimalSep;
 305     char m_cThousandsSep;
 306
 307     CTemperature::Unit m_tempUnit;
 308     CSpeed::Unit m_speedUnit;
 309   };
 310
 311
 312   typedef std::map<std::string, CRegion> MAPREGIONS;
 313   typedef std::map<std::string, CRegion>::iterator ITMAPREGIONS;
 314   typedef std::pair<std::string, CRegion> PAIR_REGIONS;
 315   MAPREGIONS m_regions;
 316   CRegion* m_currentRegion; // points to the current region
 317   CRegion m_defaultRegion; // default, will be used if no region available via langinfo.xml
 318   std::locale m_systemLocale;     // current locale, matching GUI settings
 319   std::locale m_originalLocale; // original locale, without changes of collate
 320   int m_collationtype;
 321   LanguageResourcePtr m_languageAddon;
 322
 323   std::string m_strGuiCharSet;
 324   bool m_forceUnicodeFont;
 325   std::string m_strSubtitleCharSet;
 326   std::string m_strDVDMenuLanguage;
 327   std::string m_strDVDAudioLanguage;
 328   std::string m_strDVDSubtitleLanguage;
 329   std::set<std::string> m_sortTokens;
 330
 331   std::string m_shortDateFormat;
 332   std::string m_longDateFormat;
 333   std::string m_timeFormat;
 334   bool m_use24HourClock;
 335   CTemperature::Unit m_temperatureUnit;
 336   CSpeed::Unit m_speedUnit;
 337
 338   std::string m_audioLanguage; // ISO 639-2 three char (not win32 specific)
 339   std::string m_subtitleLanguage; // ISO 639-2 three char (not win32 specific)
 340   std::string m_languageCodeGeneral; // ISO 639-2 three char (not win32-specific)
 341 };
 342
 343
 344 XBMC_GLOBAL_REF(CLangInfo, g_langInfo);
 345 #define g_langInfo XBMC_GLOBAL_USE(CLangInfo)