GUIFontManager.h

Go to the documentation of this file.

/*
 *  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 "IMsgTargetCallback.h"
#include "threads/CriticalSection.h"
#include "threads/SingleLock.h"
#include "utils/ColorUtils.h"
#include "utils/GlobalsHandling.h"
#include "windowing/GraphicContext.h"

#include <set>
#include <utility>
#include <vector>

// Forward
class CGUIFont;
class CGUIFontTTF;
class CXBMCTinyXML;
class TiXmlNode;
class CSetting;
struct StringSettingOption;

struct OrigFontInfo
{
  int size;
  float aspect;
  std::string fontFilePath;
  std::string fileName;
  RESOLUTION_INFO sourceRes;
  bool preserveAspect;
  bool border;
};

struct FontMetadata
{
  FontMetadata(const std::string& filename, const std::set<std::string>& familyNames)
    : m_filename{filename}, m_familyNames{familyNames}
  {
  }

  std::string m_filename;
  std::set<std::string> m_familyNames;
};

class GUIFontManager : public IMsgTargetCallback
{
public:
  GUIFontManager();
  ~GUIFontManager() override;

  void Initialize();

  bool IsUpdating() const { return m_critSection.IsLocked(); }

  bool OnMessage(CGUIMessage& message) override;

  void Unload(const std::string& strFontName);
  void LoadFonts(const std::string& fontSet);
  CGUIFont* LoadTTF(const std::string& strFontName,
                    const std::string& strFilename,
                    UTILS::COLOR::Color textColor,
                    UTILS::COLOR::Color shadowColor,
                    const int iSize,
                    const int iStyle,
                    bool border = false,
                    float lineSpacing = 1.0f,
                    float aspect = 1.0f,
                    const RESOLUTION_INFO* res = nullptr,
                    bool preserveAspect = false);
  CGUIFont* GetFont(const std::string& strFontName, bool fallback = true);

  CGUIFont* GetDefaultFont(bool border = false);

  void Clear();
  void FreeFontFile(CGUIFontTTF* pFont);

  static void SettingOptionsFontsFiller(const std::shared_ptr<const CSetting>& setting,
                                        std::vector<StringSettingOption>& list,
                                        std::string& current,
                                        void* data);

  std::vector<std::string> GetUserFontsFamilyNames();

protected:
  void ReloadTTFFonts();
  static void RescaleFontSizeAndAspect(CGraphicContext& context,
                                       float* size,
                                       float* aspect,
                                       const RESOLUTION_INFO& sourceRes,
                                       bool preserveAspect);
  void LoadFonts(const TiXmlNode* fontNode);
  CGUIFontTTF* GetFontFile(const std::string& fontIdent);
  static void GetStyle(const TiXmlNode* fontNode, int& iStyle);

  std::vector<std::unique_ptr<CGUIFont>> m_vecFonts;
  std::vector<std::unique_ptr<CGUIFontTTF>> m_vecFontFiles;
  std::vector<OrigFontInfo> m_vecFontInfo;
  RESOLUTION_INFO m_skinResolution;
  bool m_canReload{true};

private:
  void LoadUserFonts();
  bool LoadFontsFromFile(const std::string& fontsetFilePath,
                         const std::string& fontSet,
                         std::string& firstFontset);

  mutable CCriticalSection m_critSection;
  std::vector<FontMetadata> m_userFontsCache;
};

XBMC_GLOBAL_REF(GUIFontManager, g_fontManager);
#define g_fontManager XBMC_GLOBAL_USE(GUIFontManager)