sdl2-win93 1.0.0

data/ext/sdl2_ext/extconf.rb

@@ -0,0 +1,22 @@
+require 'mkmf'
+
+pkg_config "sdl2"
+pkg_config "SDL2_mixer"
+pkg_config "SDL2_ttf"
+pkg_config "SDL2_image"
+pkg_config "SDL2_gfx"
+
+have_header "SDL_image.h"
+have_header "SDL_mixer.h"
+have_header "SDL_ttf.h"
+have_header("SDL_filesystem.h")
+have_header "SDL2_gfxPrimitives.h"
+
+have_const("MIX_INIT_MODPLUG", "SDL_mixer.h")
+have_const("MIX_INIT_FLUIDSYNTH", "SDL_mixer.h")
+have_const("MIX_INIT_MID", "SDL_mixer.h")
+have_const("SDL_RENDERER_PRESENTVSYNC", "SDL_render.h")
+have_const("SDL_WINDOW_ALLOW_HIGHDPI", "SDL_video.h")
+have_const("SDL_WINDOW_MOUSE_CAPTURE", "SDL_video.h")
+
+create_makefile('sdl2_ext')

data/ext/sdl2_ext/filesystem.c

@@ -0,0 +1,63 @@
+#ifdef HAVE_SDL_FILESYSTEM_H
+#include "rubysdl2_internal.h"
+#include <SDL_filesystem.h>
+
+/*
+ * Get the directory where the application was run from.
+ *
+ * In almost all cases, using this method, you will get the directory where ruby executable is in.
+ * Probably what you hope is $0 or __FILE__.
+ * 
+ * @return [String] an absolute path in UTF-8 encoding to the application data directory
+ * @raise [SDL2::Error] raised if your platform doesn't implement this functionality.
+ * @note This method is available since SDL 2.0.1.
+ */
+static VALUE SDL2_s_base_path(VALUE self)
+{
+    char* path = SDL_GetBasePath();
+    VALUE str;
+    if (!path)
+        SDL_ERROR();
+    str = utf8str_new_cstr(path);
+    SDL_free(path);
+    return str;
+}
+
+/*
+ * @overload preference_path(org, app)
+ *   Get the "pref dir". You can use the directory to write personal files such as
+ *   preferences and save games.
+ *   
+ *   The directory is unique per user and per application.
+ *
+ *   @param org [String] the name of your organization
+ *   @param app [String] the name of your application
+ *   @return [String] a UTF-8 string of the user directory in platform-depnedent notation.
+ * 
+ *   @raise [SDL2::Error] raised if your platform doesn't implement this functionality.
+ *   @note This method is available since SDL 2.0.1.
+ *
+ *   @example
+ *     SDL2.preference_path("foo", "bar") # => "/home/ohai/.local/share/foo/bar/" (on Linux)
+ */
+static VALUE SDL2_s_preference_path(VALUE self, VALUE org, VALUE app)
+{
+    char* path = SDL_GetPrefPath(StringValueCStr(org), StringValueCStr(app));
+    VALUE str;
+    if (!path)
+        SDL_ERROR();
+    str = utf8str_new_cstr(path);
+    SDL_free(path);
+    return str;
+}
+
+void rubysdl2_init_filesystem(void)
+{
+    rb_define_module_function(mSDL2, "base_path", SDL2_s_base_path, 0);
+    rb_define_module_function(mSDL2, "preference_path", SDL2_s_preference_path, 2);
+}
+#else
+void rubysdl2_init_filesystem(void)
+{
+}
+#endif

data/ext/sdl2_ext/gamecontroller.c

@@ -0,0 +1,408 @@
+/* -*- mode: C -*- */
+#include "rubysdl2_internal.h"
+#include <SDL_gamecontroller.h>
+
+static VALUE cGameController;
+static VALUE mAxis;
+static VALUE mButton;
+
+typedef struct GameController {
+    SDL_GameController* controller;
+} GameController;
+
+static void GameController_free(GameController* g)
+{
+    if (rubysdl2_is_active() && g->controller)
+        SDL_GameControllerClose(g->controller);
+    free(g);
+}
+
+/*
+ * Document-class: SDL2::GameController
+ *
+ * This class represents a "Game Controller".
+ *
+ * In SDL2, there is a gamecontroller framework to
+ * hide the details of joystick types. This framework
+ * is built on the existing joystick API.
+ * 
+ * The framework consists of two parts:
+ *
+ * * Mapping joysticks to game controllers
+ * * Aquire input from game controllers
+ *
+ * Mapping information is a string, and described as:
+ *
+ *    GUID,name,mapping
+ *
+ * GUID is a unique ID of a type of joystick and
+ * given by {Joystick#GUID}. name is the human readable
+ * string for the device, and mappings are contorller mappings
+ * to joystick ones.
+ * 
+ * This mappings abstract the details of joysticks, for exmaple,
+ * the number of buttons, the number of axes, and the position
+ * of these buttons a on pad.
+ * You can use unified interface 
+ * with this framework theoretically.
+ * Howerver, we need to prepare the
+ * database of many joysticks that users will use. A database
+ * is available at https://github.com/gabomdq/SDL_GameControllerDB,
+ * but perhaps this is not sufficient for your usage.
+ * In fact, Steam prepares its own database for Steam games,
+ * so if you will create a game for Steam, this framework is
+ * useful. Otherwise, it is a better way to use joystick API
+ * directly.
+ *
+ * @!method destroy?
+ *   Return true if the gamecontroller is already closed.
+ */
+
+static VALUE GameController_new(SDL_GameController* controller)
+{
+    GameController* g = ALLOC(GameController);
+    g->controller = controller;
+    return Data_Wrap_Struct(cGameController, 0, GameController_free, g);
+}
+
+DEFINE_WRAPPER(SDL_GameController, GameController, controller, cGameController,
+               "SDL2::GameController");
+
+
+/*
+ * @overload add_mapping(string)
+ *
+ *   Add suuport for controolers that SDL is unaware of or to cause an
+ *   existing controller to have a different binding.
+ *
+ *   "GUID,name,mapping", where GUID is
+ *   the string value from SDL_JoystickGetGUIDString(), name is the human
+ *   readable string for the device and mappings are controller mappings to
+ *   joystick ones. Under Windows there is a reserved GUID of "xinput" that
+ *   covers all XInput devices. The mapping format for joystick is:
+ * 
+ *   * bX:   a joystick button, index X
+ *   * hX.Y: hat X with value Y
+ *   * aX:   axis X of the joystick
+ *
+ *   Buttons can be used as a controller axes and vice versa.
+ *
+ *   This string shows an example of a valid mapping for a controller:
+ *   "341a3608000000000000504944564944,Afterglow PS3 Controller,a:b1,b:b2,y:b3,x:b0,start:b9,guide:b12,back:b8,dpup:h0.1,dpleft:h0.8,dpdown:h0.4,dpright:h0.2,leftshoulder:b4,,rightshoulder:b5,leftstick:b10,rightstick:b11,leftx:a0,lefty:a1,rightx:a2,righty:a3,lefttrigger:b6,righttrigger:b7"
+ *   
+ *   @param string [String] mapping string
+ *   @return [Integer] 1 if a new mapping, 0 if an existing mapping is updated.
+ */
+static VALUE GameController_s_add_mapping(VALUE self, VALUE string)
+{
+    int ret = HANDLE_ERROR(SDL_GameControllerAddMapping(StringValueCStr(string)));
+    return INT2NUM(ret);
+}
+
+/*
+ * @overload axis_name_of(axis)
+ *
+ *   Get a string representing **axis**.
+ *
+ *   @param axis [Integer] axis constant in {Axis}
+ *   @return [String]
+ */
+static VALUE GameController_s_axis_name_of(VALUE self, VALUE axis)
+{
+    const char* name = SDL_GameControllerGetStringForAxis(NUM2INT(axis));
+    if (!name) {
+        SDL_SetError("Unknown axis %d", NUM2INT(axis));
+        SDL_ERROR();
+    }
+    return utf8str_new_cstr(name);
+}
+
+/*
+ * @overload button_name_of(button)
+ *
+ *   Get a string representing **button**.
+ *
+ *   @param button [Integer] button constant in {Button}
+ *   @return [String]
+ */
+static VALUE GameController_s_button_name_of(VALUE self, VALUE button)
+{
+    const char* name = SDL_GameControllerGetStringForButton(NUM2INT(button));
+    if (!name) {
+        SDL_SetError("Unknown axis %d", NUM2INT(button));
+        SDL_ERROR();
+    }
+    return utf8str_new_cstr(name);
+}
+
+/*
+ * @overload axis_from_name(name)
+ *
+ *   Get a integer representation of the axis
+ *   whose string representation is **name**.
+ *
+ *   The return value is the value of one of the constants in {Axis}
+ *
+ *   @param name [String] a string representing an axis
+ *   @return [Integer]
+ */
+static VALUE GameController_s_axis_from_name(VALUE self, VALUE name)
+{
+    int axis = SDL_GameControllerGetAxisFromString(StringValueCStr(name));
+    if (axis < 0) {
+        SDL_SetError("Unknown axis name \"%s\"", StringValueCStr(name));
+        SDL_ERROR();
+    } 
+    return INT2FIX(axis);
+}
+
+/*
+ * @overload button_from_name(name)
+ *
+ *   Get a integer representation of the button
+ *   whose string representation is **name**.
+ *
+ *   The return value is the value of one of the constants in {Button}
+ *
+ *   @param name [String] a string representing a button
+ *   @return [Integer]
+ */
+static VALUE GameController_s_button_from_name(VALUE self, VALUE name)
+{
+    int button = SDL_GameControllerGetButtonFromString(StringValueCStr(name));
+    if (button < 0) {
+        SDL_SetError("Unknown button name \"%s\"", StringValueCStr(name));
+        SDL_ERROR();
+    }
+    return INT2FIX(button);
+}
+
+/*
+ * Get the implementation dependent name for the game controllers
+ * connected to the machine.
+ * 
+ * The number of elements of returning array is same as
+ * {Joystick.num_connected_joysticks}.
+ * 
+ * @return [Array<String,nil>]
+ */
+static VALUE GameController_s_device_names(VALUE self)
+{
+    int num_joysticks = SDL_NumJoysticks();
+    int i;
+    VALUE device_names = rb_ary_new2(num_joysticks);
+    for (i=0; i<num_joysticks; ++i) {
+        const char* name = SDL_GameControllerNameForIndex(i);
+        if (name)
+            rb_ary_push(device_names, utf8str_new_cstr(name));
+        else
+            rb_ary_push(device_names, Qnil);
+    }
+    return device_names;
+}
+
+/*
+ * @overload mapping_for(guid_string)
+ *   Get the game controller mapping string for a given GUID.
+ *   
+ *   @param guid_string [String] GUID string
+ *   
+ *   @return [String] 
+ */
+static VALUE GameController_s_mapping_for(VALUE self, VALUE guid_string)
+{
+    SDL_JoystickGUID guid = SDL_JoystickGetGUIDFromString(StringValueCStr(guid_string));
+    return utf8str_new_cstr(SDL_GameControllerMappingForGUID(guid));
+}
+
+/*
+ * @overload open(index) 
+ *   Open a game controller and return the opened GameController object.
+ *   
+ *   @param index [Integer] device index, up to the return value of {Joystick.num_connected_joysticks}.
+ *   @return [SDL2::GameController]
+ *   
+ *   @raise [SDL2::Error] raised when device open is failed.
+ *     For exmaple, **index** is out of range.
+ */
+static VALUE GameController_s_open(VALUE self, VALUE index)
+{
+    SDL_GameController* controller = SDL_GameControllerOpen(NUM2INT(index));
+    if (!controller)
+        SDL_ERROR();
+    return GameController_new(controller);
+}
+
+/*
+ * Get the name of an opened game controller.
+ *
+ * @return [String]
+ */
+static VALUE GameController_name(VALUE self)
+{
+    const char* name = SDL_GameControllerName(Get_SDL_GameController(self));
+    if (!name)
+        SDL_ERROR();
+
+    return utf8str_new_cstr(name);
+}
+
+/*
+ * Return true if **self** is opened and attached.
+ */
+static VALUE GameController_attached_p(VALUE self)
+{
+    return INT2BOOL(SDL_GameControllerGetAttached(Get_SDL_GameController(self)));
+}
+
+/*
+ * Close the game controller.
+ * 
+ * @return nil
+ */
+static VALUE GameController_destroy(VALUE self)
+{
+    GameController* g = Get_GameController(self);
+    if (g->controller)
+        SDL_GameControllerClose(g->controller);
+    g->controller = NULL;
+    return Qnil;
+}
+
+/*
+ * Get the mapping string of **self**.
+ *
+ * @return [String]
+ * @see .add_mapping
+ * @see .mapping_for
+ */
+static VALUE GameController_mapping(VALUE self)
+{
+    return utf8str_new_cstr(SDL_GameControllerMapping(Get_SDL_GameController(self)));
+}
+
+/*
+ * @overload axis(axis)
+ *   Get the state of an axis control.
+ *   
+ *   The state is an integer from -32768 to 32767. 
+ *   The state of trigger never returns negative value (from 0 to 32767).
+ *   
+ *   @param axis [Integer] the index of an axis, one of the constants in {Axis}
+ *   @return [Integer]
+ */
+static VALUE GameController_axis(VALUE self, VALUE axis)
+{
+    return INT2FIX(SDL_GameControllerGetAxis(Get_SDL_GameController(self),
+                                             NUM2INT(axis)));
+}
+
+/*
+ * @overload button_pressed?(button) 
+ *   Return true if a button is pressed.
+ *   
+ *   @param button [Integer] the index of a button, one of the constants in {Button}
+ */
+static VALUE GameController_button_pressed_p(VALUE self, VALUE button)
+{
+    return INT2BOOL(SDL_GameControllerGetButton(Get_SDL_GameController(self),
+                                                NUM2INT(button)));
+}
+
+/*
+ * Document-module: SDL2::GameController::Axis
+ *
+ * This module provides constants of gamecontroller's axis indices used by
+ * {SDL2::GameController} class.
+ */
+
+/*
+ * Document-module: SDL2::GameController::Button
+ *
+ * This module provides constants of gamecontroller's button indices used by
+ * {SDL2::GameController} class.
+ */
+void rubysdl2_init_gamecontorller(void)
+{
+    cGameController = rb_define_class_under(mSDL2, "GameController", rb_cObject);
+
+    rb_define_singleton_method(cGameController, "add_mapping",
+                               GameController_s_add_mapping, 1);
+    rb_define_singleton_method(cGameController, "device_names",
+                               GameController_s_device_names, 0);
+    rb_define_singleton_method(cGameController, "axis_name_of",
+                               GameController_s_axis_name_of, 1);
+    rb_define_singleton_method(cGameController, "button_name_of",
+                               GameController_s_button_name_of, 1);
+    rb_define_singleton_method(cGameController, "mapping_for",
+                               GameController_s_mapping_for, 1);
+    rb_define_singleton_method(cGameController, "button_from_name",
+                               GameController_s_button_from_name, 1);
+    rb_define_singleton_method(cGameController, "axis_from_name",
+                               GameController_s_axis_from_name, 1);
+    rb_define_singleton_method(cGameController, "open", GameController_s_open, 1);
+    rb_define_method(cGameController, "destroy?", GameController_destroy_p, 0);
+    rb_define_method(cGameController, "destroy", GameController_destroy, 0);
+    rb_define_method(cGameController, "name", GameController_name, 0);
+    rb_define_method(cGameController, "attached?", GameController_attached_p, 0);
+    rb_define_method(cGameController, "mapping", GameController_mapping, 0);
+    rb_define_method(cGameController, "axis", GameController_axis, 1);
+    rb_define_method(cGameController, "button_pressed?", GameController_button_pressed_p, 1);
+
+    mAxis = rb_define_module_under(cGameController, "Axis");
+    mButton = rb_define_module_under(cGameController, "Button");
+
+    /*  */
+    /* Invalid axis index */
+    rb_define_const(mAxis, "INVALID", INT2NUM(SDL_CONTROLLER_AXIS_INVALID));
+    /* Left X axis */
+    rb_define_const(mAxis, "LEFTX", INT2NUM(SDL_CONTROLLER_AXIS_LEFTX));
+    /* Left Y axis */
+    rb_define_const(mAxis, "LEFTY", INT2NUM(SDL_CONTROLLER_AXIS_LEFTY));
+    /* Right X axis */
+    rb_define_const(mAxis, "RIGHTX", INT2NUM(SDL_CONTROLLER_AXIS_RIGHTX));
+    /* Right Y axis */
+    rb_define_const(mAxis, "RIGHTY", INT2NUM(SDL_CONTROLLER_AXIS_RIGHTY));
+    /* Left trigger axis */
+    rb_define_const(mAxis, "TRIGGERLEFT", INT2NUM(SDL_CONTROLLER_AXIS_TRIGGERLEFT));
+    /* Right trigger axis */
+    rb_define_const(mAxis, "TRIGGERRIGHT", INT2NUM(SDL_CONTROLLER_AXIS_TRIGGERRIGHT));
+    /* The max of an axis index */
+    rb_define_const(mAxis, "MAX", INT2NUM(SDL_CONTROLLER_AXIS_MAX));
+
+    /*  */
+    /* Invalid button index */
+    rb_define_const(mButton, "INVALID", INT2NUM(SDL_CONTROLLER_BUTTON_INVALID));
+    /* Button A */
+    rb_define_const(mButton, "A", INT2NUM(SDL_CONTROLLER_BUTTON_A));
+    /* Button B */
+    rb_define_const(mButton, "B", INT2NUM(SDL_CONTROLLER_BUTTON_B));
+    /* Button X */
+    rb_define_const(mButton, "X", INT2NUM(SDL_CONTROLLER_BUTTON_X));
+    /* Button Y */
+    rb_define_const(mButton, "Y", INT2NUM(SDL_CONTROLLER_BUTTON_Y));
+    /* Back Button */
+    rb_define_const(mButton, "BACK", INT2NUM(SDL_CONTROLLER_BUTTON_BACK));
+    /* Guide Button */
+    rb_define_const(mButton, "GUIDE", INT2NUM(SDL_CONTROLLER_BUTTON_GUIDE));
+    /* Start Button */
+    rb_define_const(mButton, "START", INT2NUM(SDL_CONTROLLER_BUTTON_START));
+    /* Left stick Button */
+    rb_define_const(mButton, "LEFTSTICK", INT2NUM(SDL_CONTROLLER_BUTTON_LEFTSTICK));
+    /* Right stick Button */
+    rb_define_const(mButton, "RIGHTSTICK", INT2NUM(SDL_CONTROLLER_BUTTON_RIGHTSTICK));
+    /* Left shoulder Button */
+    rb_define_const(mButton, "LEFTSHOULDER", INT2NUM(SDL_CONTROLLER_BUTTON_LEFTSHOULDER));
+    /* Right shoulder Button */
+    rb_define_const(mButton, "RIGHTSHOULDER", INT2NUM(SDL_CONTROLLER_BUTTON_RIGHTSHOULDER));
+    /* D-pad UP Button */
+    rb_define_const(mButton, "DPAD_UP", INT2NUM(SDL_CONTROLLER_BUTTON_DPAD_UP));
+    /* D-pad DOWN Button */
+    rb_define_const(mButton, "DPAD_DOWN", INT2NUM(SDL_CONTROLLER_BUTTON_DPAD_DOWN));
+    /* D-pad LEFT Button */
+    rb_define_const(mButton, "DPAD_LEFT", INT2NUM(SDL_CONTROLLER_BUTTON_DPAD_LEFT));
+    /* D-pad RIGHT Button */
+    rb_define_const(mButton, "DPAD_RIGHT", INT2NUM(SDL_CONTROLLER_BUTTON_DPAD_RIGHT));
+    /* The max of a button index */
+    rb_define_const(mButton, "MAX", INT2NUM(SDL_CONTROLLER_BUTTON_MAX));
+}