ruby-sdl2 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 0ba98c59e4cc9e1521e4f521a593f9229f4d3b53
-  data.tar.gz: 8b61b2c7a6bd524b5fd54ef7ed7e4ec6df16df3d
+  metadata.gz: 3117676fab3bf728061ced8e70ae5854d6b2ac9e
+  data.tar.gz: aa03377e9a9c236dee4e850b9e47a4f897e33672
 SHA512:
-  metadata.gz: cda57903640382a7780b8ff43faeaebafbfed416ad9003a49069125485c497ad180b17a9f4d403d08da122fdf2bceda509563119fb5b05d8535000ef62053245
-  data.tar.gz: 2b923a1f3e19db9d998040bbbe472798b70b6ae034b838f3fa43990ad7090d441d7567b5cf467216dacf115d0f374863b9b226de18100a32c9fdda07013a034a
+  metadata.gz: aa5917cb8bf99824a3019735cb24fd984a5e2d0ac1846f8bbeb62b6c2f1cc6972b00c906478474dc92ae3e916bcf223d2314d1d5b204fe6558391d7835c38f44
+  data.tar.gz: 961679df11d15cc1e03055e3566480eb1a681227a54eadbb5a6bfce3a67d1cb8b21ce24923ddcd9a00aa8d30bb50cc16e6e0251aaf7846e4ba06bafdece517fd

data/.gitignore

@@ -7,6 +7,7 @@ video.c
 gl.c
 ttf.c
 mixer.c
+joystick.c
 gamecontroller.c
 pkg/
 TAGS

data/README.md

@@ -19,7 +19,11 @@ from github:
     cd ruby-sdl2
     rake gem
     gem install pkg/ruby-sdl2-x.y.z.gem
-    
+
+# Document
+
+* [English Reference manual](http://ohai.github.io/ruby-sdl2/doc-en/)
+
 # License
 
 LGPL v3 (see {file:COPYING.txt}).

data/joystick.c

@@ -1,9 +1,11 @@
+/* -*- mode: C -*- */
 #include "rubysdl2_internal.h"
 #include <SDL_joystick.h>
 #include <SDL_gamecontroller.h>
 
 static VALUE cJoystick;
 static VALUE cDeviceInfo;
+static VALUE mHat;
 
 typedef struct Joystick {
     SDL_Joystick* joystick;
@@ -266,6 +268,16 @@ static VALUE Joystick_hat(VALUE self, VALUE which)
  *
  * You can get the information with {SDL2::Joystick.devices}.
  */
+
+/*
+ * Document-module: SDL2::Joystick::Hat
+ *
+ * This module provides constants of joysticks's hat positions used by {SDL2::Joystick} class.
+ * The position of the hat is represented by OR'd bits of {RIGHT}, {LEFT}, {UP}, and {DOWN}.
+ * This means the center position ({CENTERED}) is represeted by 0 and
+ * the left up position {LEFTUP} is represeted by ({LEFT}|{UP}).
+ */
+
 void rubysdl2_init_joystick(void)
 {
     cJoystick = rb_define_class_under(mSDL2, "Joystick", rb_cObject);
@@ -293,17 +305,28 @@ void rubysdl2_init_joystick(void)
     rb_define_method(cJoystick, "ball", Joystick_ball, 1);
     rb_define_method(cJoystick, "button", Joystick_button, 1);
     rb_define_method(cJoystick, "hat", Joystick_hat, 1);
-#define DEFINE_JOY_HAT_CONST(state) \
-    rb_define_const(cJoystick, "HAT_" #state, INT2NUM(SDL_HAT_##state))
-    DEFINE_JOY_HAT_CONST(CENTERED);
-    DEFINE_JOY_HAT_CONST(UP);
-    DEFINE_JOY_HAT_CONST(RIGHT);
-    DEFINE_JOY_HAT_CONST(DOWN);
-    DEFINE_JOY_HAT_CONST(LEFT);
-    DEFINE_JOY_HAT_CONST(RIGHTUP);
-    DEFINE_JOY_HAT_CONST(RIGHTDOWN);
-    DEFINE_JOY_HAT_CONST(LEFTUP);
-    DEFINE_JOY_HAT_CONST(LEFTDOWN);
+
+    mHat = rb_define_module_under(cJoystick, "Hat");
+    
+    /*  */
+    /* Center position. Equal to 0. */
+    rb_define_const(mHat, "CENTERED", INT2NUM(SDL_HAT_CENTERED));
+    /* Up position. */
+    rb_define_const(mHat, "UP", INT2NUM(SDL_HAT_UP));
+    /* Right position. */
+    rb_define_const(mHat, "RIGHT", INT2NUM(SDL_HAT_RIGHT));
+    /* Down position. */
+    rb_define_const(mHat, "DOWN", INT2NUM(SDL_HAT_DOWN));
+    /* Left position. */
+    rb_define_const(mHat, "LEFT", INT2NUM(SDL_HAT_LEFT));
+    /* Right Up position. Equal to ({RIGHT} | {UP}) */
+    rb_define_const(mHat, "RIGHTUP", INT2NUM(SDL_HAT_RIGHTUP));
+    /* Right Down position. Equal to ({RIGHT} | {DOWN}) */
+    rb_define_const(mHat, "RIGHTDOWN", INT2NUM(SDL_HAT_RIGHTDOWN));
+    /* Left Up position. Equal to ({LEFT} | {UP}) */
+    rb_define_const(mHat, "LEFTUP", INT2NUM(SDL_HAT_LEFTUP));
+    /* Left Down position. Equal to ({LEFT} | {DOWN}) */
+    rb_define_const(mHat, "LEFTDOWN", INT2NUM(SDL_HAT_LEFTDOWN));
 
     /* Device GUID
      * @return [String] */

data/joystick.c.m4

@@ -0,0 +1,339 @@
+/* -*- mode: C -*- */
+#include "rubysdl2_internal.h"
+#include <SDL_joystick.h>
+#include <SDL_gamecontroller.h>
+
+static VALUE cJoystick;
+static VALUE cDeviceInfo;
+static VALUE mHat;
+
+typedef struct Joystick {
+    SDL_Joystick* joystick;
+} Joystick;
+
+static void Joystick_free(Joystick* j)
+{
+    if (rubysdl2_is_active() && j->joystick)
+        SDL_JoystickClose(j->joystick);
+    free(j);
+}
+
+static VALUE Joystick_new(SDL_Joystick* joystick)
+{
+    Joystick* j = ALLOC(Joystick);
+    j->joystick = joystick;
+    return Data_Wrap_Struct(cJoystick, 0, Joystick_free, j);
+}
+
+DEFINE_WRAPPER(SDL_Joystick, Joystick, joystick, cJoystick, "SDL2::Joystick");
+
+/*
+ * Document-class: SDL2::Joystick
+ *
+ * This class represents a joystick connected to the machine.
+ *
+ * In order to use joystick subsystem, {SDL2.init} must have been called
+ * with the SDL2::INIT_JOYSTICK flag.
+ *
+ * @!method destroy?
+ *   Return true if the device is alread closed.
+ *   @see #destroy
+ */
+
+/*
+ * Get the number of connected joysticks.
+ *
+ * @return [Integer]
+ */
+static VALUE Joystick_s_num_connected_joysticks(VALUE self)
+{
+    return INT2FIX(HANDLE_ERROR(SDL_NumJoysticks()));
+}
+
+static VALUE GUID_to_String(SDL_JoystickGUID guid)
+{
+    char buf[128];
+    SDL_JoystickGetGUIDString(guid, buf, sizeof(buf));
+    return rb_usascii_str_new_cstr(buf);
+}
+
+/*
+ * Get the information of connected joysticks
+ *
+ * @return [Array<SDL2::Joystick::DeviceInfo>] information of connected devices
+ */
+static VALUE Joystick_s_devices(VALUE self)
+{
+    int num_joysticks = SDL_NumJoysticks();
+    int i;
+    VALUE devices = rb_ary_new2(num_joysticks);
+    for (i=0; i<num_joysticks; ++i) {
+        VALUE device = rb_obj_alloc(cDeviceInfo);
+        rb_iv_set(device, "@GUID", GUID_to_String(SDL_JoystickGetDeviceGUID(i)));
+        rb_iv_set(device, "@name", utf8str_new_cstr(SDL_JoystickNameForIndex(i)));
+        rb_ary_push(devices, device);
+    }
+    return devices;
+}
+
+/*
+ * @overload open(device_index)
+ *   Open a joystick for use.
+ *
+ *   @param [Integer] device_index device index
+ *   @return [SDL2::Joystick] opended joystick object
+ *   @raise [SDL2::Error] raised when device open is failed.
+ *     for exmaple, device_index is out of range.
+ */
+static VALUE Joystick_s_open(VALUE self, VALUE device_index)
+{
+    SDL_Joystick* joystick = SDL_JoystickOpen(NUM2INT(device_index));
+    if (!joystick)
+        SDL_ERROR();
+    return Joystick_new(joystick);
+}
+
+/*
+ * @overload game_controller?(index)
+ *   Return true if the joystick of given index supports the game controller
+ *   interface.
+ *
+ *   @param [Integer] index the joystick device index
+ *   @see SDL2::GameController
+ * 
+ */
+static VALUE Joystick_s_game_controller_p(VALUE self, VALUE index)
+{
+    return INT2BOOL(SDL_IsGameController(NUM2INT(index)));
+}
+
+/*
+ * Return true a joystick has been opened and currently connected.
+ */
+static VALUE Joystick_attached_p(VALUE self)
+{
+    Joystick* j = Get_Joystick(self);
+    if (!j->joystick)
+        return Qfalse;
+    return INT2BOOL(SDL_JoystickGetAttached(j->joystick));
+}
+
+/*
+ * Get the joystick GUID
+ *
+ * @return [String] GUID string
+ */
+static VALUE Joystick_GUID(VALUE self)
+{
+    SDL_JoystickGUID guid;
+    char buf[128];
+    guid = SDL_JoystickGetGUID(Get_SDL_Joystick(self));
+    SDL_JoystickGetGUIDString(guid, buf, sizeof(buf));
+    return rb_usascii_str_new_cstr(buf);
+}
+
+/*
+ * Get the index of a joystick
+ *
+ * @return [Integer] index
+ */
+static VALUE Joystick_index(VALUE self)
+{
+    return INT2NUM(HANDLE_ERROR(SDL_JoystickInstanceID(Get_SDL_Joystick(self))));
+}
+
+/*
+ * Close a joystick device.
+ * 
+ * @return [nil]
+ * @see #destroy?
+ */
+static VALUE Joystick_destroy(VALUE self)
+{
+    Joystick* j = Get_Joystick(self);
+    if (j->joystick)
+        SDL_JoystickClose(j->joystick);
+    j->joystick = NULL;
+    return Qnil;
+}
+
+/*
+ * Get the name of a joystick
+ *
+ * @return [String] name
+ */
+static VALUE Joystick_name(VALUE self)
+{
+    return utf8str_new_cstr(SDL_JoystickName(Get_SDL_Joystick(self)));
+}
+
+/*
+ * Get the number of general axis controls on a joystick.
+ * @return [Integer]
+ * @see #axis
+ */
+static VALUE Joystick_num_axes(VALUE self)
+{
+    return INT2FIX(SDL_JoystickNumAxes(Get_SDL_Joystick(self)));
+}
+
+/*
+ * Get the number of trackball on a joystick
+ * @return [Integer]
+ * @see #ball
+ */
+static VALUE Joystick_num_balls(VALUE self)
+{
+    return INT2FIX(SDL_JoystickNumBalls(Get_SDL_Joystick(self)));
+}
+
+/*
+ * Get the number of button on a joystick
+ * @return [Integer]
+ * @see #button
+ */
+static VALUE Joystick_num_buttons(VALUE self)
+{
+    return INT2FIX(SDL_JoystickNumButtons(Get_SDL_Joystick(self)));
+}
+
+/*
+ * Get the number of POV hats on a joystick
+ * @return [Integer]
+ * @see #hat
+ */
+static VALUE Joystick_num_hats(VALUE self)
+{
+    return INT2FIX(SDL_JoystickNumHats(Get_SDL_Joystick(self)));
+}
+
+/*
+ * @overload axis(which) 
+ *   Get the current state of an axis control on a joystick.
+ *   
+ *   @param [Integer] which an index of an axis, started at index 0
+ *   @return [Integer] state value, ranging from -32768 to 32767.
+ *   @see #num_axes
+ */
+static VALUE Joystick_axis(VALUE self, VALUE which)
+{
+    return INT2FIX(SDL_JoystickGetAxis(Get_SDL_Joystick(self), NUM2INT(which)));
+}
+
+/*
+ * @overload ball(which) 
+ *   Get the current state of a trackball on a joystick.
+ *   
+ *   @param [Integer] which an index of a trackball, started at index 0
+ *   @return [[Integer,Integer]] dx and dy
+ *   @see #num_balls
+ */
+static VALUE Joystick_ball(VALUE self, VALUE which)
+{
+    int dx, dy;
+    HANDLE_ERROR(SDL_JoystickGetBall(Get_SDL_Joystick(self), NUM2INT(which), &dx, &dy));
+    return rb_ary_new3(2, INT2NUM(dx), INT2NUM(dy));
+}
+
+/*
+ * @overload button(which)
+ *   Get the current state of a button on a joystick.
+ *
+ *   @param [Integer] which an index of a button, started at index 0
+ *   @return [Boolean] true if the button is pressed
+ *   @see #num_buttons
+ */
+static VALUE Joystick_button(VALUE self, VALUE which)
+{
+    return INT2BOOL(SDL_JoystickGetButton(Get_SDL_Joystick(self), NUM2INT(which)));
+}
+
+/*
+ * @overload hat(which)
+ *   Get the current state of a POV hat on a joystick.
+ *
+ *   @param [Integer] which an index of a hat, started at index 0
+ *   @return [Integer] hat state
+ *   @see #num_hats
+ */
+static VALUE Joystick_hat(VALUE self, VALUE which)
+{
+    return UINT2NUM(SDL_JoystickGetHat(Get_SDL_Joystick(self), NUM2INT(which)));
+}
+
+/*
+ * Document-class: SDL2::Joystick::DeviceInfo
+ *
+ * This class represents joystick device information, its name and GUID.
+ *
+ * You can get the information with {SDL2::Joystick.devices}.
+ */
+
+/*
+ * Document-module: SDL2::Joystick::Hat
+ *
+ * This module provides constants of joysticks's hat positions used by {SDL2::Joystick} class.
+ * The position of the hat is represented by OR'd bits of {RIGHT}, {LEFT}, {UP}, and {DOWN}.
+ * This means the center position ({CENTERED}) is represeted by 0 and
+ * the left up position {LEFTUP} is represeted by ({LEFT}|{UP}).
+ */
+
+void rubysdl2_init_joystick(void)
+{
+    cJoystick = rb_define_class_under(mSDL2, "Joystick", rb_cObject);
+    cDeviceInfo = rb_define_class_under(cJoystick, "DeviceInfo", rb_cObject);
+    
+    rb_define_singleton_method(cJoystick, "num_connected_joysticks",
+                               Joystick_s_num_connected_joysticks, 0);
+    rb_define_singleton_method(cJoystick, "devices", Joystick_s_devices, 0);
+    rb_define_singleton_method(cJoystick, "open", Joystick_s_open, 1);
+    rb_define_singleton_method(cJoystick, "game_controller?",
+                               Joystick_s_game_controller_p, 1);
+    rb_define_method(cJoystick, "destroy?", Joystick_destroy_p, 0);
+    rb_define_alias(cJoystick, "close?", "destroy?");
+    rb_define_method(cJoystick, "attached?", Joystick_attached_p, 0);
+    rb_define_method(cJoystick, "GUID", Joystick_GUID, 0);
+    rb_define_method(cJoystick, "index", Joystick_index, 0);
+    rb_define_method(cJoystick, "destroy", Joystick_destroy, 0);
+    rb_define_alias(cJoystick, "close", "destroy");
+    rb_define_method(cJoystick, "name", Joystick_name, 0);
+    rb_define_method(cJoystick, "num_axes", Joystick_num_axes, 0);
+    rb_define_method(cJoystick, "num_balls", Joystick_num_balls, 0);
+    rb_define_method(cJoystick, "num_buttons", Joystick_num_buttons, 0);
+    rb_define_method(cJoystick, "num_hats", Joystick_num_hats, 0);
+    rb_define_method(cJoystick, "axis", Joystick_axis, 1);
+    rb_define_method(cJoystick, "ball", Joystick_ball, 1);
+    rb_define_method(cJoystick, "button", Joystick_button, 1);
+    rb_define_method(cJoystick, "hat", Joystick_hat, 1);
+
+    mHat = rb_define_module_under(cJoystick, "Hat");
+    
+    /* define(`DEFINE_JOY_HAT_CONST',`rb_define_const(mHat, "$1", INT2NUM(SDL_HAT_$1))') */
+    /* Center position. Equal to 0. */
+    DEFINE_JOY_HAT_CONST(CENTERED);
+    /* Up position. */
+    DEFINE_JOY_HAT_CONST(UP);
+    /* Right position. */
+    DEFINE_JOY_HAT_CONST(RIGHT);
+    /* Down position. */
+    DEFINE_JOY_HAT_CONST(DOWN);
+    /* Left position. */
+    DEFINE_JOY_HAT_CONST(LEFT);
+    /* Right Up position. Equal to ({RIGHT} | {UP}) */
+    DEFINE_JOY_HAT_CONST(RIGHTUP);
+    /* Right Down position. Equal to ({RIGHT} | {DOWN}) */
+    DEFINE_JOY_HAT_CONST(RIGHTDOWN);
+    /* Left Up position. Equal to ({LEFT} | {UP}) */
+    DEFINE_JOY_HAT_CONST(LEFTUP);
+    /* Left Down position. Equal to ({LEFT} | {DOWN}) */
+    DEFINE_JOY_HAT_CONST(LEFTDOWN);
+
+    /* Device GUID
+     * @return [String] */
+    rb_define_attr(cDeviceInfo, "GUID", 1, 0);
+    /* Device name
+     * @return [String] */
+    rb_define_attr(cDeviceInfo, "name", 1, 0);
+
+    
+}

data/key.c.m4

@@ -173,22 +173,55 @@ static VALUE Mod_s_set_state(VALUE self, VALUE keymod)
  *
  * This module provides Unicode text input support.
  *
+ * Normally, you can handle key inputs from key events
+ * and {SDL2::Key} module. This module is required to
+ * input thousands kinds of symbols like CJK languages.
+ * Please see {https://wiki.libsdl.org/Tutorials/TextInput}
+ * to understand the concept of Unicode text input.
+ */
+
+/*
+ * Return true if Unicode text input events are enabled.
+ *
+ * @see .start
+ * @see .stop
  */
 static VALUE TextInput_s_active_p(VALUE self)
 {
     return INT2BOOL(SDL_IsTextInputActive());
 }
 
+/*
+ * Enable Unicode input events.
+ *
+ * @return [nil]
+ * @see .stop
+ * @see .active?
+ */
 static VALUE TextInput_s_start(VALUE self)
 {
     SDL_StartTextInput(); return Qnil;
 }
 
+/*
+ * Disable Unicode input events.
+ *
+ * @return [nil]
+ * @see .start
+ * @see .active?
+ */
 static VALUE TextInput_s_stop(VALUE self)
 {
     SDL_StopTextInput(); return Qnil;
 }
 
+/*
+ * @overload rect=(rect)
+ *   Set the rectanlgle used to type Unicode text inputs.
+ *
+ *   @param rect [SDL2::Rect] the rectangle to receive text
+ *   @return [rect]
+ */
 static VALUE TextInput_s_set_rect(VALUE self, VALUE rect)
 {
     SDL_Rect *r = Get_SDL_Rect(rect);

data/lib/sdl2/version.rb

@@ -1,6 +1,6 @@
 module SDL2
   # Version string of Ruby/SDL2
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
   # Version of Ruby/SDL2, [major, minor, patch level] 
   VERSION_NUMBER = [0, 2, 0]
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-sdl2
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Ippei Obayashi
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-09-15 00:00:00.000000000 Z
+date: 2015-09-23 00:00:00.000000000 Z
 dependencies: []
 description: |2
         Ruby/SDL2 is an extension library to use SDL 2.x
@@ -40,6 +40,7 @@ files:
 - gl.c.m4
 - hint.c
 - joystick.c
+- joystick.c.m4
 - key.c
 - key.c.m4
 - lib/sdl2.rb