GUIInfoLabel.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 "interfaces/info/Info.h"

#include <functional>
#include <string>
#include <vector>

class CGUIListItem;

namespace KODI
{
namespace GUILIB
{
namespace GUIINFO
{

class CGUIInfoLabel
{
public:
  CGUIInfoLabel() = default;
  CGUIInfoLabel(const std::string& label,
                const std::string& fallback = "",
                int context = INFO::DEFAULT_CONTEXT);

  void SetLabel(const std::string& label,
                const std::string& fallback,
                int context = INFO::DEFAULT_CONTEXT);

  const std::string &GetLabel(int contextWindow, bool preferImage = false, std::string *fallback = NULL) const;

  int GetIntValue(int contextWindow) const;

  const std::string& GetItemLabel(const CGUIListItem* item,
                                  bool preferImage = false,
                                  std::string* fallback = nullptr) const;

  bool IsConstant() const;
  bool IsEmpty() const;

  const std::string& GetFallback() const { return m_fallback; }

  static std::string GetLabel(const std::string& label,
                              int contextWindow,
                              bool preferImage = false);
  static std::string GetItemLabel(const std::string &label, const CGUIListItem *item, bool preferImage = false);

  static std::string ReplaceLocalize(const std::string &label);

  static std::string ReplaceAddonStrings(std::string &&label);

  static std::string ReplaceControllerStrings(std::string&& label);

  typedef std::function<std::string(const std::string&)> StringReplacerFunc;

  static bool ReplaceSpecialKeywordReferences(const std::string &strInput, const std::string &strKeyword, const StringReplacerFunc &func, std::string &strOutput);

  static bool ReplaceSpecialKeywordReferences(std::string &work, const std::string &strKeyword, const StringReplacerFunc &func);

private:
  class CInfoPortion
  {
  public:
    CInfoPortion(int info, const std::string &prefix, const std::string &postfix, bool escaped = false);
    bool NeedsUpdate(const std::string &label) const;
    std::string Get() const;
    int m_info;
  private:
    bool m_escaped;
    mutable std::string m_label;
    std::string m_prefix;
    std::string m_postfix;
  };

  void Parse(const std::string& label, std::vector<CInfoPortion>& infoPortion, int context);

  const std::string& CacheLabel(bool rebuild) const;

  void RebuildLabel(std::string& label, const std::vector<CInfoPortion>& infoPortion) const;

  bool LabelNeedsUpdate(int context,
                        bool preferImages,
                        std::string* fallback,
                        const std::vector<CInfoPortion>& infoPortion) const;
  bool ItemLabelNeedsUpdate(const CGUIListItem* item,
                            bool preferImages,
                            std::string* fallback,
                            const std::vector<CInfoPortion>& infoPortion) const;

  mutable bool        m_dirty = false;
  mutable std::string m_label;
  mutable std::string m_fallback;
  std::vector<CInfoPortion> m_infoLabel;
  std::vector<CInfoPortion> m_infoFallback;
};

} // namespace GUIINFO
} // namespace GUILIB
} // namespace KODI