PVRChannelNumberInputHandler.h

/*
 *  Copyright (C) 2012-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 "pvr/channels/PVRChannelNumber.h"
#include "threads/CriticalSection.h"
#include "threads/Timer.h"
#include "utils/EventStream.h"

#include <string>
#include <vector>

namespace PVR
{
struct PVRChannelNumberInputChangedEvent
{
  explicit PVRChannelNumberInputChangedEvent(const std::string& input) : m_input(input) {}
  virtual ~PVRChannelNumberInputChangedEvent() = default;

  std::string m_input;
};

class CPVRChannelNumberInputHandler : private ITimerCallback
{
public:
  static const int CHANNEL_NUMBER_INPUT_MAX_DIGITS = 5;

  CPVRChannelNumberInputHandler();

  CPVRChannelNumberInputHandler(int iDelay, int iMaxDigits = CHANNEL_NUMBER_INPUT_MAX_DIGITS);

  ~CPVRChannelNumberInputHandler() override = default;

  CEventStream<PVRChannelNumberInputChangedEvent>& Events() { return m_events; }

  // implementation of ITimerCallback
  void OnTimeout() override;

  virtual void GetChannelNumbers(std::vector<std::string>& channelNumbers) = 0;

  virtual void OnInputDone() = 0;

  virtual void AppendChannelNumberCharacter(char cCharacter);

  bool HasChannelNumber() const;

  std::string GetChannelNumberLabel() const;

  bool CheckInputAndExecuteAction();

protected:
  CPVRChannelNumber GetChannelNumber() const;

  size_t GetCurrentDigitCount() const { return m_inputBuffer.size(); }

  mutable CCriticalSection m_mutex;

private:
  void ExecuteAction();

  void SetLabel(const std::string& label);

  std::vector<std::string> m_sortedChannelNumbers;
  const int m_iDelay;
  const int m_iMaxDigits;
  std::string m_inputBuffer;
  std::string m_label;
  CTimer m_timer;
  CEventSource<PVRChannelNumberInputChangedEvent> m_events;
};

} // namespace PVR