IConfigurationWindow.h

/*
 *  Copyright (C) 2014-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 "games/controllers/ControllerTypes.h"
#include "input/InputTypes.h"
#include "input/joysticks/JoystickTypes.h"

#include <string>
#include <vector>

class CEvent;

namespace KODI
{
namespace GAME
{
class CPhysicalFeature;

class IControllerList
{
public:
  virtual ~IControllerList() = default;

  virtual bool Initialize(void) = 0;

  virtual void Deinitialize(void) = 0;

  virtual bool Refresh(const std::string& controllerId) = 0;

  /*
   * \brief  The specified controller has been focused
   *
   * \param  controllerIndex The index of the controller being focused
   */
  virtual void OnFocus(unsigned int controllerIndex) = 0;

  virtual void OnSelect(unsigned int controllerIndex) = 0;

  virtual int GetFocusedController() const = 0;

  virtual void ResetController(void) = 0;
};

class IFeatureList
{
public:
  virtual ~IFeatureList() = default;

  virtual bool Initialize(void) = 0;

  virtual void Deinitialize(void) = 0;

  virtual bool HasButton(JOYSTICK::FEATURE_TYPE type) const = 0;

  virtual void Load(const ControllerPtr& controller) = 0;

  virtual void OnFocus(unsigned int buttonIndex) = 0;

  virtual void OnSelect(unsigned int buttonIndex) = 0;
};

class IFeatureButton
{
public:
  virtual ~IFeatureButton() = default;

  virtual const CPhysicalFeature& Feature(void) const = 0;

  virtual bool AllowWizard() const { return true; }

  virtual bool PromptForInput(CEvent& waitEvent) = 0;

  virtual bool IsFinished(void) const = 0;

  virtual INPUT::CARDINAL_DIRECTION GetCardinalDirection(void) const = 0;

  virtual JOYSTICK::WHEEL_DIRECTION GetWheelDirection(void) const = 0;

  virtual JOYSTICK::THROTTLE_DIRECTION GetThrottleDirection(void) const = 0;

  virtual bool NeedsKey() const { return false; }

  virtual void SetKey(const CPhysicalFeature& key) {}

  virtual void Reset(void) = 0;
};

class IConfigurationWizard
{
public:
  virtual ~IConfigurationWizard() = default;

  virtual void Run(const std::string& strControllerId,
                   const std::vector<IFeatureButton*>& buttons) = 0;

  virtual void OnUnfocus(IFeatureButton* button) = 0;

  virtual bool Abort(bool bWait = true) = 0;

  virtual void RegisterKey(const CPhysicalFeature& key) = 0;

  virtual void UnregisterKeys() = 0;
};
} // namespace GAME
} // namespace KODI