IButtonMap.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/DriverPrimitive.h"
#include "input/joysticks/JoystickTypes.h"

#include <string>
#include <vector>

namespace KODI
{
namespace JOYSTICK
{
class IButtonMap
{
public:
  virtual ~IButtonMap() = default;

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

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

  virtual bool Load(void) = 0;

  virtual void Reset(void) = 0;

  virtual bool IsEmpty(void) const = 0;

  virtual std::string GetAppearance() const = 0;

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

  virtual bool GetFeature(const CDriverPrimitive& primitive, FeatureName& feature) = 0;

  virtual FEATURE_TYPE GetFeatureType(const FeatureName& feature) = 0;

  virtual bool GetScalar(const FeatureName& feature, CDriverPrimitive& primitive) = 0;

  virtual void AddScalar(const FeatureName& feature, const CDriverPrimitive& primitive) = 0;

  virtual bool GetAnalogStick(const FeatureName& feature,
                              ANALOG_STICK_DIRECTION direction,
                              CDriverPrimitive& primitive) = 0;

  virtual void AddAnalogStick(const FeatureName& feature,
                              ANALOG_STICK_DIRECTION direction,
                              const CDriverPrimitive& primitive) = 0;

  virtual bool GetRelativePointer(const FeatureName& feature,
                                  RELATIVE_POINTER_DIRECTION direction,
                                  CDriverPrimitive& primitive) = 0;

  virtual void AddRelativePointer(const FeatureName& feature,
                                  RELATIVE_POINTER_DIRECTION direction,
                                  const CDriverPrimitive& primitive) = 0;

  virtual bool GetAccelerometer(const FeatureName& feature,
                                CDriverPrimitive& positiveX,
                                CDriverPrimitive& positiveY,
                                CDriverPrimitive& positiveZ) = 0;

  virtual void AddAccelerometer(const FeatureName& feature,
                                const CDriverPrimitive& positiveX,
                                const CDriverPrimitive& positiveY,
                                const CDriverPrimitive& positiveZ) = 0;

  virtual bool GetWheel(const FeatureName& feature,
                        WHEEL_DIRECTION direction,
                        CDriverPrimitive& primitive) = 0;

  virtual void AddWheel(const FeatureName& feature,
                        WHEEL_DIRECTION direction,
                        const CDriverPrimitive& primitive) = 0;

  virtual bool GetThrottle(const FeatureName& feature,
                           THROTTLE_DIRECTION direction,
                           CDriverPrimitive& primitive) = 0;

  virtual void AddThrottle(const FeatureName& feature,
                           THROTTLE_DIRECTION direction,
                           const CDriverPrimitive& primitive) = 0;

  virtual bool GetKey(const FeatureName& feature, CDriverPrimitive& primitive) = 0;

  virtual void AddKey(const FeatureName& feature, const CDriverPrimitive& primitive) = 0;

  virtual void SetIgnoredPrimitives(const std::vector<CDriverPrimitive>& primitives) = 0;

  virtual bool IsIgnored(const CDriverPrimitive& primitive) = 0;

  virtual bool GetAxisProperties(unsigned int axisIndex, int& center, unsigned int& range) = 0;

  virtual void SaveButtonMap() = 0;

  virtual void RevertButtonMap() = 0;
};
} // namespace JOYSTICK
} // namespace KODI