xbmc/guilib/GUIAction.cpp

   1 /*
   2  *  Copyright (C) 2005-2018 Team Kodi
   3  *  This file is part of Kodi - https://kodi.tv
   4  *
   5  *  SPDX-License-Identifier: GPL-2.0-or-later
   6  *  See LICENSES/README.md for more information.
   7  */
   8
   9 #include "GUIAction.h"
  10
  11 #include "GUIComponent.h"
  12 #include "GUIInfoManager.h"
  13 #include "GUIWindowManager.h"
  14 #include "ServiceBroker.h"
  15 #include "utils/StringUtils.h"
  16
  17 namespace
  18 {
  19 constexpr int DEFAULT_CONTROL_ID = 0;
  20 }
  21
  22 CGUIAction::CExecutableAction::CExecutableAction(const std::string& action) : m_action{action}
  23 {
  24 }
  25
  26 CGUIAction::CExecutableAction::CExecutableAction(const std::string& condition,
  27                                                  const std::string& action)
  28   : m_condition{condition}, m_action{action}
  29 {
  30 }
  31
  32 std::string CGUIAction::CExecutableAction::GetCondition() const
  33 {
  34   return m_condition;
  35 }
  36
  37 std::string CGUIAction::CExecutableAction::GetAction() const
  38 {
  39   return m_action;
  40 }
  41
  42 bool CGUIAction::CExecutableAction::HasCondition() const
  43 {
  44   return !m_condition.empty();
  45 }
  46
  47 void CGUIAction::CExecutableAction::SetAction(const std::string& action)
  48 {
  49   m_action = action;
  50 }
  51
  52 CGUIAction::CGUIAction(int controlID)
  53 {
  54   SetNavigation(controlID);
  55 }
  56
  57 bool CGUIAction::ExecuteActions() const
  58 {
  59   return ExecuteActions(DEFAULT_CONTROL_ID, DEFAULT_CONTROL_ID);
  60 }
  61
  62 bool CGUIAction::ExecuteActions(int controlID,
  63                                 int parentID,
  64                                 const std::shared_ptr<CGUIListItem>& item /* = NULL */) const
  65 {
  66   if (m_actions.empty())
  67     return false;
  68
  69   CGUIInfoManager& infoMgr = CServiceBroker::GetGUI()->GetInfoManager();
  70   // take a copy of actions that satisfy our conditions
  71   std::vector<std::string> actions;
  72   for (const auto &i : m_actions)
  73   {
  74     if (!i.HasCondition() || infoMgr.EvaluateBool(i.GetCondition(), 0, item))
  75     {
  76       if (!StringUtils::IsInteger(i.GetAction()))
  77         actions.emplace_back(i.GetAction());
  78     }
  79   }
  80   // execute them
  81   bool retval = false;
  82   for (const auto &i : actions)
  83   {
  84     CGUIMessage msg(GUI_MSG_EXECUTE, controlID, parentID, 0, 0, item);
  85     msg.SetStringParam(i);
  86     if (m_sendThreadMessages)
  87       CServiceBroker::GetGUI()->GetWindowManager().SendThreadMessage(msg);
  88     else
  89       CServiceBroker::GetGUI()->GetWindowManager().SendMessage(msg);
  90     retval = true;
  91   }
  92   return retval;
  93 }
  94
  95 int CGUIAction::GetNavigation() const
  96 {
  97   CGUIInfoManager& infoMgr = CServiceBroker::GetGUI()->GetInfoManager();
  98   for (const auto &i : m_actions)
  99   {
 100     if (StringUtils::IsInteger(i.GetAction()))
 101     {
 102       if (!i.HasCondition() || infoMgr.EvaluateBool(i.GetCondition(), INFO::DEFAULT_CONTEXT))
 103         return std::stoi(i.GetAction());
 104     }
 105   }
 106   return 0;
 107 }
 108
 109 void CGUIAction::SetNavigation(int id)
 110 {
 111   if (id == 0)
 112     return;
 113
 114   std::string strId = std::to_string(id);
 115   for (auto &i : m_actions)
 116   {
 117     if (StringUtils::IsInteger(i.GetAction()) && !i.HasCondition())
 118     {
 119       i.SetAction(strId);
 120       return;
 121     }
 122   }
 123   m_actions.emplace_back(std::move(strId));
 124 }
 125
 126 bool CGUIAction::HasConditionalActions() const
 127 {
 128   for (const auto& i : m_actions)
 129   {
 130     if (i.HasCondition())
 131       return true;
 132   }
 133   return false;
 134 }
 135
 136 bool CGUIAction::HasActionsMeetingCondition() const
 137 {
 138   CGUIInfoManager& infoMgr = CServiceBroker::GetGUI()->GetInfoManager();
 139   for (const auto &i : m_actions)
 140   {
 141     if (!i.HasCondition() || infoMgr.EvaluateBool(i.GetCondition(), INFO::DEFAULT_CONTEXT))
 142       return true;
 143   }
 144   return false;
 145 }
 146
 147 bool CGUIAction::HasAnyActions() const
 148 {
 149   return m_actions.size() > 0;
 150 }
 151
 152 size_t CGUIAction::GetActionCount() const
 153 {
 154   return m_actions.size();
 155 }
 156
 157 void CGUIAction::Append(const CExecutableAction& action)
 158 {
 159   m_actions.emplace_back(action);
 160 }
 161
 162 void CGUIAction::EnableSendThreadMessageMode()
 163 {
 164   m_sendThreadMessages = true;
 165 }
 166
 167 void CGUIAction::Reset()
 168 {
 169   m_actions.clear();
 170 }