Joystick.hpp

/******************************************************************************
 
  nomlib - C++11 cross-platform game engine
 
Copyright (c) 2013, 2014 Jeffrey Carpenter <i8degrees@gmail.com>
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
 
1. Redistributions of source code must retain the above copyright notice, this
   list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright notice,
   this list of conditions and the following disclaimer in the documentation
   and/or other materials provided with the distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
******************************************************************************/
#ifndef NOMLIB_SYSTEM_JOYSTICK_HPP
#define NOMLIB_SYSTEM_JOYSTICK_HPP
 
#include <string>
#include <memory>
 
#include "nomlib/config.hpp"
 
// Forward declarations (third-party)
typedef struct _SDL_Joystick SDL_Joystick;
 
namespace nom {
 
typedef int32 JoystickIndex;

typedef int32 JoystickID;

const nom::size_type GUID_MAX_LENGTH = 16;

struct JoystickGUID
{
  uint8 data[GUID_MAX_LENGTH];
};

const int16 JOYSTICK_LEFT_THUMB_DEAD_ZONE = 7849;
const int16 JOYSTICK_RIGHT_THUMB_DEAD_ZONE = 8689;
const int16 JOYSTICK_TRIGGER_THRESHOLD = 30;

bool init_joystick_subsystem();

void shutdown_joystick_subsystem();

void JoystickDeleter(SDL_Joystick* dev);

class Joystick
{
  public:
    enum Axis: uint8
    {
      AXIS_ZERO = 0,
      AXIS_ONE,
      AXIS_TWO,
      AXIS_THREE,
      AXIS_FOUR,
      AXIS_FIVE,
      AXIS_SIX,
      AXIS_SEVEN,
      AXIS_EIGHT,
      AXIS_MAX,
    };

    enum Button: uint8
    {
      BUTTON_ZERO = 0,
      BUTTON_ONE,
      BUTTON_TWO,
      BUTTON_THREE,
      BUTTON_FOUR,
      BUTTON_FIVE,
      BUTTON_SIX,
      BUTTON_SEVEN,
      BUTTON_EIGHT,
      BUTTON_NINE,
      BUTTON_TEN,
      BUTTON_ELEVEN,
      BUTTON_TWELVE,
      BUTTON_FOURTEEN,
      BUTTON_FIFTEEN,
      BUTTON_SIXTEEN,
      BUTTON_MAX,
    };

    enum Hat: uint8
    {
      HAT_ZERO = 0,
      HAT_ONE,
      HAT_TWO,
      HAT_THREE,
      HAT_FOUR,
      HAT_MAX,
    };

    enum HatPosition: uint8
    {
      HAT_CENTERED = 0x00,
      HAT_UP = 0x01,
      HAT_RIGHT = 0x02,
      HAT_DOWN = 0x04,
      HAT_LEFT = 0x08,
      HAT_RIGHTUP = (HAT_RIGHT | HAT_UP),
      HAT_RIGHTDOWN = (HAT_RIGHT | HAT_DOWN),
      HAT_LEFTUP = (HAT_LEFT | HAT_UP),
      HAT_LEFTDOWN = (HAT_LEFT | HAT_DOWN),
    };
 
    typedef Joystick self_type;
 
    Joystick();
 
    ~Joystick();

    SDL_Joystick* device() const;

    bool attached() const;

    JoystickID device_id() const;

    std::string name() const;

    bool open(JoystickIndex device_index);

    void close();

    int num_axes();

    int num_track_balls();

    int num_buttons();

    int num_hats();

    static int set_event_state(int state);

    static void update();

    static int num_joysticks();

    static std::string name(JoystickIndex device_index);

    JoystickGUID device_guid() const;

    static JoystickGUID device_guid(JoystickIndex device_index);

    static std::string device_guid_string(JoystickGUID guid);

    std::string device_guid_string() const;

    static JoystickID device_id(JoystickIndex device_index);
 
  private:
    typedef std::unique_ptr<SDL_Joystick, void (*)(SDL_Joystick*)> joystick_dev;
 
    joystick_dev device_;
};
 
std::unique_ptr<Joystick> make_unique_joystick();
std::shared_ptr<Joystick> make_shared_joystick();
 
JoystickGUID convert_SDL_JoystickGUID(SDL_JoystickGUID dev_guid);
SDL_JoystickGUID convert_SDL_JoystickGUID(JoystickGUID dev_guid);
 
} // namespace nom
 
#endif // include guard defined