GameController.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_GAME_CONTROLLER_HPP
#define NOMLIB_SYSTEM_GAME_CONTROLLER_HPP
 
#include "nomlib/config.hpp"
#include "nomlib/system/Joystick.hpp"
 
// Forward declarations (third-party)
typedef struct _SDL_Joystick SDL_Joystick;
typedef struct _SDL_GameController SDL_GameController;
 
namespace nom {

bool init_game_controller_subsystem();

void shutdown_game_controller_subsystem();

void GameControllerDeleter(SDL_GameController* dev);

class GameController
{
  public:
    enum Axis: int8
    {
      AXIS_INVALID = -1,
      AXIS_LEFT_X,
      AXIS_LEFT_Y,
      AXIS_RIGHT_X,
      AXIS_RIGHT_Y,
      AXIS_TRIGGER_LEFT,
      AXIS_TRIGGER_RIGHT,
      AXIS_MAX,
    };

    enum Button: int8
    {
      BUTTON_INVALID = -1,
      BUTTON_A,
      BUTTON_B,
      BUTTON_X,
      BUTTON_Y,
      BUTTON_BACK,
      BUTTON_GUIDE,
      BUTTON_START,
      BUTTON_LEFT_STICK,
      BUTTON_RIGHT_STICK,
      BUTTON_LEFT_SHOULDER,
      BUTTON_RIGHT_SHOULDER,
      BUTTON_DPAD_UP,
      BUTTON_DPAD_DOWN,
      BUTTON_DPAD_LEFT,
      BUTTON_DPAD_RIGHT,
      BUTTON_MAX = SDL_CONTROLLER_BUTTON_MAX,
    };
 
    // NOTE: This is a workaround to prevent a double-free bug that
    // occasionally happens when the joystick device is closed more than once.
    // This issue can be reliably reproduced by adding a second
    // SDL_GameControllerClose call to test/testgamecontroller.c from the SDL
    // source repository.
    static bool device_closed_;
 
    typedef GameController self_type;
 
    GameController();
 
    ~GameController();

    SDL_Joystick* device() const;

    bool attached() const;

    JoystickID device_id() const;

    std::string name() const;

    bool open(JoystickIndex device_index);

    void close();

    static std::string name(JoystickIndex device_index);

    static int set_event_state(int state);

    static void update();
 
    std::string mapping_string();

    static std::string mapping_string(JoystickGUID guid);

    static int load_mapping_memory(const char* buffer, int buffer_size);

    static int load_mapping_file(const std::string& filename);
 
    static int load_mapping_string(const std::string& mapping);

    static JoystickID device_id(JoystickIndex device_index);

    static bool compatible_joystick(JoystickIndex device_index);
 
  private:
    typedef std::unique_ptr<SDL_GameController, void (*)(SDL_GameController*)>
    joystick_dev;
 
    joystick_dev device_;
};
 
std::unique_ptr<GameController> make_unique_game_controller();
std::shared_ptr<GameController> make_shared_game_controller();
 
} // namespace nom
 
#endif // include guard defined