diff options
Diffstat (limited to 'xbmc/GUIInfoManager.h')
| -rw-r--r-- | xbmc/GUIInfoManager.h | 230 |
1 files changed, 230 insertions, 0 deletions
diff --git a/xbmc/GUIInfoManager.h b/xbmc/GUIInfoManager.h new file mode 100644 index 0000000..1098281 --- /dev/null +++ b/xbmc/GUIInfoManager.h @@ -0,0 +1,230 @@ +/* + * 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 "guilib/guiinfo/GUIInfoProviders.h" +#include "interfaces/info/InfoBool.h" +#include "interfaces/info/SkinVariable.h" +#include "messaging/IMessageTarget.h" +#include "threads/CriticalSection.h" + +#include <map> +#include <memory> +#include <set> +#include <string> +#include <vector> + +class CFileItem; +class CVideoInfoTag; + +class CGUIListItem; +typedef std::shared_ptr<CGUIListItem> CGUIListItemPtr; + +namespace KODI +{ +namespace GAME +{ +class CGameInfoTag; +} +namespace GUILIB +{ +namespace GUIINFO +{ + class CGUIInfo; + class IGUIInfoProvider; +} +} +} +namespace INFO +{ + class InfoSingle; +} +namespace MUSIC_INFO +{ + class CMusicInfoTag; +} + +/*! + \ingroup strings + \brief + */ +class CGUIInfoManager : public KODI::MESSAGING::IMessageTarget +{ +public: + CGUIInfoManager(void); + ~CGUIInfoManager(void) override; + + void Initialize(); + + void Clear(); + void ResetCache(); + + // KODI::MESSAGING::IMessageTarget implementation + int GetMessageMask() override; + void OnApplicationMessage(KODI::MESSAGING::ThreadMessage* pMsg) override; + + /*! \brief Register a boolean condition/expression + This routine allows controls or other clients of the info manager to register + to receive updates of particular expressions, in a particular context (currently windows). + + In the future, it will allow clients to receive pushed callbacks when the expression changes. + + \param expression the boolean condition or expression + \param context the context window + \return an identifier used to reference this expression + */ + INFO::InfoPtr Register(const std::string &expression, int context = 0); + + /*! \brief Unregister a boolean condition/expression + * This routine allows controls or other clients of the info manager to unregister a previously registered + * boolean condition/expression + \param expression the boolean condition or expression + */ + void UnRegister(const INFO::InfoPtr& expression); + + /// \brief iterates through boolean conditions and compares their stored values to current values. Returns true if any condition changed value. + bool ConditionsChangedValues(const std::map<INFO::InfoPtr, bool>& map); + + /*! \brief Evaluate a boolean expression + \param expression the expression to evaluate + \param context the context in which to evaluate the expression (currently windows) + \return the value of the evaluated expression. + \sa Register + */ + bool EvaluateBool(const std::string& expression, + int context, + const CGUIListItemPtr& item = nullptr); + + int TranslateString(const std::string &strCondition); + int TranslateSingleString(const std::string &strCondition, bool &listItemDependent); + + std::string GetLabel(int info, int contextWindow, std::string* fallback = nullptr) const; + std::string GetImage(int info, int contextWindow, std::string *fallback = nullptr); + bool GetInt(int& value, int info, int contextWindow, const CGUIListItem* item = nullptr) const; + bool GetBool(int condition, int contextWindow, const CGUIListItem* item = nullptr); + + std::string GetItemLabel(const CFileItem *item, int contextWindow, int info, std::string *fallback = nullptr) const; + std::string GetItemImage(const CGUIListItem *item, int contextWindow, int info, std::string *fallback = nullptr) const; + /*! \brief Get integer value of info. + \param value int reference to pass value of given info + \param info id of info + \param context the context in which to evaluate the expression (currently windows) + \param item optional listitem if want to get listitem related int + \return true if given info was handled + \sa GetItemInt, GetMultiInfoInt + */ + bool GetItemInt(int &value, const CGUIListItem *item, int contextWindow, int info) const; + bool GetItemBool(const CGUIListItem *item, int contextWindow, int condition) const; + + /*! \brief Set currently playing file item + */ + void SetCurrentItem(const CFileItem &item); + void ResetCurrentItem(); + void UpdateCurrentItem(const CFileItem &item); + + // Current song stuff + void SetCurrentAlbumThumb(const std::string &thumbFileName); + const MUSIC_INFO::CMusicInfoTag *GetCurrentSongTag() const; + + // Current video stuff + const CVideoInfoTag* GetCurrentMovieTag() const; + + // Current game stuff + const KODI::GAME::CGameInfoTag* GetCurrentGameTag() const; + + void UpdateAVInfo(); + + int RegisterSkinVariableString(const INFO::CSkinVariableString* info); + int TranslateSkinVariableString(const std::string& name, int context); + + /*! \brief register a guiinfo provider + \param the guiinfo provider to register + */ + void RegisterInfoProvider(KODI::GUILIB::GUIINFO::IGUIInfoProvider *provider); + + /*! \brief unregister a guiinfo provider + \param the guiinfo provider to unregister + */ + void UnregisterInfoProvider(KODI::GUILIB::GUIINFO::IGUIInfoProvider *provider); + + /*! \brief get access to the registered guiinfo providers + \return the guiinfo providers + */ + KODI::GUILIB::GUIINFO::CGUIInfoProviders& GetInfoProviders() { return m_infoProviders; } + +private: + /*! \brief class for holding information on properties + */ + class Property + { + public: + Property(const std::string &property, const std::string ¶meters); + + const std::string ¶m(unsigned int n = 0) const; + unsigned int num_params() const; + + std::string name; + private: + std::vector<std::string> params; + }; + + /*! \brief Split an info string into it's constituent parts and parameters + Format is: + + info1(params1).info2(params2).info3(params3) ... + + where the parameters are an optional comma separated parameter list. + + \param infoString the original string + \param info the resulting pairs of info and parameters. + */ + void SplitInfoString(const std::string &infoString, std::vector<Property> &info); + + int TranslateSingleString(const std::string &strCondition); + int TranslateListItem(const Property& cat, const Property& prop, int id, bool container); + int TranslateMusicPlayerString(const std::string &info) const; + int TranslateVideoPlayerString(const std::string& info) const; + int TranslatePlayerString(const std::string& info) const; + static TIME_FORMAT TranslateTimeFormat(const std::string &format); + + std::string GetMultiInfoLabel(const KODI::GUILIB::GUIINFO::CGUIInfo &info, int contextWindow, std::string *fallback = nullptr) const; + bool GetMultiInfoInt(int &value, const KODI::GUILIB::GUIINFO::CGUIInfo &info, int contextWindow, const CGUIListItem *item) const; + bool GetMultiInfoBool(const KODI::GUILIB::GUIINFO::CGUIInfo &info, int contextWindow, const CGUIListItem *item); + + std::string GetMultiInfoItemLabel(const CFileItem *item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo &info, std::string *fallback = nullptr) const; + std::string GetMultiInfoItemImage(const CFileItem *item, int contextWindow, const KODI::GUILIB::GUIINFO::CGUIInfo &info, std::string *fallback = nullptr) const; + + std::string GetSkinVariableString(int info, + int contextWindow, + bool preferImage = false, + const CGUIListItem* item = nullptr) const; + + int AddMultiInfo(const KODI::GUILIB::GUIINFO::CGUIInfo &info); + + int ResolveMultiInfo(int info) const; + bool IsListItemInfo(int info) const; + + void SetCurrentSongTag(const MUSIC_INFO::CMusicInfoTag &tag); + void SetCurrentVideoTag(const CVideoInfoTag &tag); + + // Vector of multiple information mapped to a single integer lookup + std::vector<KODI::GUILIB::GUIINFO::CGUIInfo> m_multiInfo; + + // Current playing stuff + CFileItem* m_currentFile; + + typedef std::set<INFO::InfoPtr, bool(*)(const INFO::InfoPtr&, const INFO::InfoPtr&)> INFOBOOLTYPE; + INFOBOOLTYPE m_bools; + unsigned int m_refreshCounter = 0; + std::vector<INFO::CSkinVariableString> m_skinVariableStrings; + + CCriticalSection m_critInfo; + + KODI::GUILIB::GUIINFO::CGUIInfoProviders m_infoProviders; +}; |