xbmc/pvr/addons/PVRClientMenuHooks.cpp

   1 /*
   2  *  Copyright (C) 2012-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 "PVRClientMenuHooks.h"
  10
  11 #include "addons/kodi-dev-kit/include/kodi/c-api/addon-instance/pvr/pvr_menu_hook.h"
  12 #include "guilib/LocalizeStrings.h"
  13 #include "pvr/PVRContextMenus.h"
  14 #include "utils/log.h"
  15
  16 #include <memory>
  17
  18 namespace PVR
  19 {
  20
  21 CPVRClientMenuHook::CPVRClientMenuHook(const std::string& addonId, const PVR_MENUHOOK& hook)
  22 : m_addonId(addonId),
  23   m_hook(new PVR_MENUHOOK(hook))
  24 {
  25   if (hook.category != PVR_MENUHOOK_UNKNOWN &&
  26       hook.category != PVR_MENUHOOK_ALL &&
  27       hook.category != PVR_MENUHOOK_CHANNEL &&
  28       hook.category != PVR_MENUHOOK_TIMER &&
  29       hook.category != PVR_MENUHOOK_EPG &&
  30       hook.category != PVR_MENUHOOK_RECORDING &&
  31       hook.category != PVR_MENUHOOK_DELETED_RECORDING &&
  32       hook.category != PVR_MENUHOOK_SETTING)
  33     CLog::LogF(LOGERROR, "Unknown PVR_MENUHOOK_CAT value: {}", hook.category);
  34 }
  35
  36 bool CPVRClientMenuHook::operator ==(const CPVRClientMenuHook& right) const
  37 {
  38   if (this == &right)
  39     return true;
  40
  41   return m_addonId == right.m_addonId &&
  42          m_hook->iHookId == right.m_hook->iHookId &&
  43          m_hook->iLocalizedStringId == right.m_hook->iLocalizedStringId &&
  44          m_hook->category == right.m_hook->category;
  45 }
  46
  47 bool CPVRClientMenuHook::IsAllHook() const
  48 {
  49   return m_hook->category == PVR_MENUHOOK_ALL;
  50 }
  51
  52 bool CPVRClientMenuHook::IsChannelHook() const
  53 {
  54   return m_hook->category == PVR_MENUHOOK_CHANNEL;
  55 }
  56
  57 bool CPVRClientMenuHook::IsTimerHook() const
  58 {
  59   return m_hook->category == PVR_MENUHOOK_TIMER;
  60 }
  61
  62 bool CPVRClientMenuHook::IsEpgHook() const
  63 {
  64   return m_hook->category == PVR_MENUHOOK_EPG;
  65 }
  66
  67 bool CPVRClientMenuHook::IsRecordingHook() const
  68 {
  69   return m_hook->category == PVR_MENUHOOK_RECORDING;
  70 }
  71
  72 bool CPVRClientMenuHook::IsDeletedRecordingHook() const
  73 {
  74   return m_hook->category == PVR_MENUHOOK_DELETED_RECORDING;
  75 }
  76
  77 bool CPVRClientMenuHook::IsSettingsHook() const
  78 {
  79   return m_hook->category == PVR_MENUHOOK_SETTING;
  80 }
  81
  82 unsigned int CPVRClientMenuHook::GetId() const
  83 {
  84   return m_hook->iHookId;
  85 }
  86
  87 unsigned int CPVRClientMenuHook::GetLabelId() const
  88 {
  89   return m_hook->iLocalizedStringId;
  90 }
  91
  92 std::string CPVRClientMenuHook::GetLabel() const
  93 {
  94   return g_localizeStrings.GetAddonString(m_addonId, m_hook->iLocalizedStringId);
  95 }
  96
  97 void CPVRClientMenuHooks::AddHook(const PVR_MENUHOOK& addonHook)
  98 {
  99   if (!m_hooks)
 100     m_hooks = std::make_unique<std::vector<CPVRClientMenuHook>>();
 101
 102   const CPVRClientMenuHook hook(m_addonId, addonHook);
 103   m_hooks->emplace_back(hook);
 104   CPVRContextMenuManager::GetInstance().AddMenuHook(hook);
 105 }
 106
 107 void CPVRClientMenuHooks::Clear()
 108 {
 109   if (!m_hooks)
 110     return;
 111
 112   for (const auto& hook : *m_hooks)
 113     CPVRContextMenuManager::GetInstance().RemoveMenuHook(hook);
 114
 115   m_hooks.reset();
 116 }
 117
 118 std::vector<CPVRClientMenuHook> CPVRClientMenuHooks::GetHooks(
 119     const std::function<bool(const CPVRClientMenuHook& hook)>& function) const
 120 {
 121   std::vector<CPVRClientMenuHook> hooks;
 122
 123   if (!m_hooks)
 124     return hooks;
 125
 126   for (const CPVRClientMenuHook& hook : *m_hooks)
 127   {
 128     if (function(hook) || hook.IsAllHook())
 129       hooks.emplace_back(hook);
 130   }
 131   return hooks;
 132 }
 133
 134 std::vector<CPVRClientMenuHook> CPVRClientMenuHooks::GetChannelHooks() const
 135 {
 136   return GetHooks([](const CPVRClientMenuHook& hook)
 137   {
 138     return hook.IsChannelHook();
 139   });
 140 }
 141
 142 std::vector<CPVRClientMenuHook> CPVRClientMenuHooks::GetTimerHooks() const
 143 {
 144   return GetHooks([](const CPVRClientMenuHook& hook)
 145   {
 146     return hook.IsTimerHook();
 147   });
 148 }
 149
 150 std::vector<CPVRClientMenuHook> CPVRClientMenuHooks::GetEpgHooks() const
 151 {
 152   return GetHooks([](const CPVRClientMenuHook& hook)
 153   {
 154     return hook.IsEpgHook();
 155   });
 156 }
 157
 158 std::vector<CPVRClientMenuHook> CPVRClientMenuHooks::GetRecordingHooks() const
 159 {
 160   return GetHooks([](const CPVRClientMenuHook& hook)
 161   {
 162     return hook.IsRecordingHook();
 163   });
 164 }
 165
 166 std::vector<CPVRClientMenuHook> CPVRClientMenuHooks::GetDeletedRecordingHooks() const
 167 {
 168   return GetHooks([](const CPVRClientMenuHook& hook)
 169   {
 170     return hook.IsDeletedRecordingHook();
 171   });
 172 }
 173
 174 std::vector<CPVRClientMenuHook> CPVRClientMenuHooks::GetSettingsHooks() const
 175 {
 176   return GetHooks([](const CPVRClientMenuHook& hook)
 177   {
 178     return hook.IsSettingsHook();
 179   });
 180 }
 181
 182 } // namespace PVR