xbmc/pvr/PVRChannelNumberInputHandler.h

   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 #pragma once
  10
  11 #include "pvr/channels/PVRChannelNumber.h"
  12 #include "threads/CriticalSection.h"
  13 #include "threads/Timer.h"
  14 #include "utils/EventStream.h"
  15
  16 #include <string>
  17 #include <vector>
  18
  19 namespace PVR
  20 {
  21 struct PVRChannelNumberInputChangedEvent
  22 {
  23   explicit PVRChannelNumberInputChangedEvent(const std::string& input) : m_input(input) {}
  24   virtual ~PVRChannelNumberInputChangedEvent() = default;
  25
  26   std::string m_input;
  27 };
  28
  29 class CPVRChannelNumberInputHandler : private ITimerCallback
  30 {
  31 public:
  32   CPVRChannelNumberInputHandler();
  33   ~CPVRChannelNumberInputHandler() override = default;
  34
  35   /*!
  36    * @brief Get the events available for CEventStream.
  37    * @return The events.
  38    */
  39   CEventStream<PVRChannelNumberInputChangedEvent>& Events() { return m_events; }
  40
  41   // implementation of ITimerCallback
  42   void OnTimeout() override;
  43
  44   /*!
  45    * @brief Get the currently available channel numbers.
  46    * @param channelNumbers The list to fill with the channel numbers.
  47    */
  48   virtual void GetChannelNumbers(std::vector<std::string>& channelNumbers) = 0;
  49
  50   /*!
  51    * @brief This method gets called after the channel number input timer has expired.
  52    */
  53   virtual void OnInputDone() = 0;
  54
  55   /*!
  56    * @brief Appends a channel number character.
  57    * @param cCharacter The character to append. value must be CPVRChannelNumber::SEPARATOR ('.') or any char in the range from '0' to '9'.
  58    */
  59   virtual void AppendChannelNumberCharacter(char cCharacter);
  60
  61   /*!
  62    * @brief Check whether a channel number was entered.
  63    * @return True if the handler currently holds a channel number, false otherwise.
  64    */
  65   bool HasChannelNumber() const;
  66
  67   /*!
  68    * @brief Get the currently entered channel number as a formatted string.
  69    * @return the channel number string.
  70    */
  71   std::string GetChannelNumberLabel() const;
  72
  73   /*!
  74    * @brief If a number was entered, execute the associated action.
  75    * @return True, if the action was executed, false otherwise.
  76    */
  77   bool CheckInputAndExecuteAction();
  78
  79 protected:
  80   /*!
  81    * @brief Get the currently entered channel number.
  82    * @return the channel number.
  83    */
  84   CPVRChannelNumber GetChannelNumber() const;
  85
  86   /*!
  87    * @brief Get the currently entered number of digits.
  88    * @return the number of digits.
  89    */
  90   size_t GetCurrentDigitCount() const { return m_inputBuffer.size(); }
  91
  92   mutable CCriticalSection m_mutex;
  93
  94 private:
  95   void ExecuteAction();
  96
  97   void SetLabel(const std::string& label);
  98
  99   std::vector<std::string> m_sortedChannelNumbers;
 100   const uint32_t m_delay;
 101   std::string m_inputBuffer;
 102   std::string m_label;
 103   CTimer m_timer;
 104   CEventSource<PVRChannelNumberInputChangedEvent> m_events;
 105 };
 106
 107 } // namespace PVR