Locale.h

/*
 *  Copyright (C) 2015-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 <set>
#include <string>
#include <unordered_map>

class CLocale
{
public:
  CLocale();
  explicit CLocale(const std::string& language);
  CLocale(const std::string& language, const std::string& territory);
  CLocale(const std::string& language, const std::string& territory, const std::string& codeset);
  CLocale(const std::string& language, const std::string& territory, const std::string& codeset, const std::string& modifier);
  ~CLocale();

  static const CLocale Empty;

  static CLocale FromString(const std::string& locale);

  bool operator==(const CLocale& other) const;
  inline bool operator!=(const CLocale& other) const { return !(*this == other); }

  bool IsValid() const { return m_valid; }

  const std::string& GetLanguageCode() const { return m_language; }
  const std::string& GetTerritoryCode() const { return m_territory; }
  const std::string& GetCodeset() const { return m_codeset; }
  const std::string& GetModifier() const { return m_modifier; }

  std::string ToString() const;
  std::string ToStringLC() const;
  std::string ToShortString() const;
  std::string ToShortStringLC() const;

  bool Equals(const std::string& locale) const;

  bool Matches(const std::string& locale) const;

  std::string FindBestMatch(const std::set<std::string>& locales) const;

  std::string FindBestMatch(const std::unordered_map<std::string, std::string>& locales) const;

private:
  static bool CheckValidity(const std::string& language, const std::string& territory, const std::string& codeset, const std::string& modifier);
  static bool ParseLocale(const std::string &locale, std::string &language, std::string &territory, std::string &codeset, std::string &modifier);

  void Initialize();

  int GetMatchRank(const std::string& locale) const;

  bool m_valid = false;
  std::string m_language;
  std::string m_territory;
  std::string m_codeset;
  std::string m_modifier;
};