IButtonMapper.h

/*
 *  Copyright (C) 2014-2024 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 "input/joysticks/JoystickTypes.h"

#include <map>
#include <string>

namespace KODI
{
namespace KEYMAP
{
class IKeymap;
} // namespace KEYMAP

namespace JOYSTICK
{
class CDriverPrimitive;
class IButtonMap;
class IButtonMapCallback;

class IButtonMapper
{
public:
  IButtonMapper() = default;

  virtual ~IButtonMapper() = default;

  virtual std::string ControllerID(void) const = 0;

  virtual bool NeedsCooldown(void) const = 0;

  virtual bool AcceptsPrimitive(PRIMITIVE_TYPE type) const = 0;

  virtual bool MapPrimitive(IButtonMap* buttonMap,
                            KEYMAP::IKeymap* keyMap,
                            const CDriverPrimitive& primitive) = 0;

  virtual void OnEventFrame(const IButtonMap* buttonMap, bool bMotion) = 0;

  virtual void OnLateAxis(const IButtonMap* buttonMap, unsigned int axisIndex) = 0;

  // Button map callback interface
  void SetButtonMapCallback(const std::string& deviceLocation, IButtonMapCallback* callback)
  {
    m_callbacks[deviceLocation] = callback;
  }
  void ResetButtonMapCallbacks(void) { m_callbacks.clear(); }
  std::map<std::string, IButtonMapCallback*>& ButtonMapCallbacks(void) { return m_callbacks; }

private:
  std::map<std::string, IButtonMapCallback*> m_callbacks; // Device location -> callback
};
} // namespace JOYSTICK
} // namespace KODI