LangCodeExpander.h

/*
 *  Copyright (C) 2005-2018 Team Kodi
 *  This file is part of Kodi - https://kodi.tv
 *
 *  SPDX-License-Identifier: GPL-2.0-or-later
 *  See LICENSES/README.md for more information.
 */

#pragma once

#include <map>
#include <string>
#include <vector>

class TiXmlElement;

class CLangCodeExpander
{
public:
  CLangCodeExpander();
  ~CLangCodeExpander();

  enum LANGFORMATS
  {
    ISO_639_1,
    ISO_639_2,
    ENGLISH_NAME
  };

  enum class LANG_LIST
  {
    // Standard ISO
    DEFAULT,
    // Standard ISO + Language addons
    INCLUDE_ADDONS,
    // Standard ISO + User defined
    // (User defined can override language name of existing codes)
    INCLUDE_USERDEFINED,
    // Standard ISO + Language addons + User defined
    // (User defined can override language name of existing codes)
    INCLUDE_ADDONS_USERDEFINED,
  };

  void LoadUserCodes(const TiXmlElement* pRootElement);
  void Clear();

  bool Lookup(const std::string& code, std::string& desc);
  bool Lookup(const int code, std::string& desc);

  bool CompareFullLanguageNames(const std::string& lang1, const std::string& lang2);

  bool CompareISO639Codes(const std::string& code1, const std::string& code2);

  bool ConvertToISO6391(const std::string& lang, std::string& code);

  std::string ConvertToISO6392B(const std::string& lang);

  static bool ConvertISO6391ToISO6392B(const std::string& strISO6391, std::string& strISO6392B, bool checkWin32Locales = false);

  bool ConvertToISO6392B(const std::string& strCharCode, std::string& strISO6392B, bool checkWin32Locales = false);

  bool ConvertToISO6392T(const std::string& strCharCode, std::string& strISO6392T, bool checkWin32Locales = false);

  std::string ConvertToISO6392T(const std::string& lang);

  /*
   * \brief Find a language code with subtag (e.g. zh-tw, zh-Hans) in to a string.
   *        This function find a limited set of IETF BCP47 specs, so:
   *        language tag + region subtag, or, language tag + script subtag.
   *        The language code can be found if wrapped by curly brackets e.g. {pt-br}.
   * \param str The string where find the language code.
   * \return The language code found in the string, otherwise empty string
   */
  static std::string FindLanguageCodeWithSubtag(const std::string& str);

#ifdef TARGET_WINDOWS
  static bool ConvertISO31661Alpha2ToISO31661Alpha3(const std::string& strISO31661Alpha2, std::string& strISO31661Alpha3);
  static bool ConvertWindowsLanguageCodeToISO6392B(const std::string& strWindowsLanguageCode, std::string& strISO6392B);
#endif

  /*
   * \brief Get the list of language names.
   * \param format [OPT] The format type.
   * \param list [OPT] The type of language list to retrieve.
   * \return The languages
   */
  std::vector<std::string> GetLanguageNames(LANGFORMATS format = ISO_639_1,
                                            LANG_LIST list = LANG_LIST::DEFAULT);

protected:
  /*
   * \brief Converts a language code given as a long, see #MAKECODE(a, b, c, d)
   *        to its string representation.
   * \param[in] code The language code given as a long, see #MAKECODE(a, b, c, d).
   * \return The string representation of the given language code code.
   */
  static std::string CodeToString(long code);

  static bool LookupInISO639Tables(const std::string& code, std::string& desc);

  /*
   * \brief Looks up the language description for given language code
   *        in to the installed language addons.
   * \param[in] code The language code for which description is looked for.
   * \param[out] desc The english language name.
   * \return true if the language description was found, false otherwise.
   */
  static bool LookupInLangAddons(const std::string& code, std::string& desc);

  bool LookupInUserMap(const std::string& code, std::string& desc);

  bool ReverseLookup(const std::string& desc, std::string& code);


  bool LookupUserCode(const std::string& desc, std::string &userCode);

  typedef std::map<std::string, std::string> STRINGLOOKUPTABLE;
  STRINGLOOKUPTABLE m_mapUser;
};

extern CLangCodeExpander g_LangCodeExpander;