ruby-sdl2 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1c1ea00e7921cc924cf00e9ac5916ba5eb4aad3a
-  data.tar.gz: 125ed016e9fd2aefd0c779a11f863dacd0cdc0da
+  metadata.gz: 0ba98c59e4cc9e1521e4f521a593f9229f4d3b53
+  data.tar.gz: 8b61b2c7a6bd524b5fd54ef7ed7e4ec6df16df3d
 SHA512:
-  metadata.gz: e19dba994d4b3e138477595ba17ff9fb323da6b98042d7d872f8b202e3d5164edd090cb6ffb76e88f64a1aa63313b43a60bf383cd047a3ef8fcd6a44e36ccda1
-  data.tar.gz: 12b3ba4f205a47c4e7c59a0b7961ef97bca6bff8b0bedb306d1477b0ab0c86879682d24aa2f697d8be1c58a9768e07c8e3e1cb475a1d7815a39430ddfb5a7196
+  metadata.gz: cda57903640382a7780b8ff43faeaebafbfed416ad9003a49069125485c497ad180b17a9f4d403d08da122fdf2bceda509563119fb5b05d8535000ef62053245
+  data.tar.gz: 2b923a1f3e19db9d998040bbbe472798b70b6ae034b838f3fa43990ad7090d441d7567b5cf467216dacf115d0f374863b9b226de18100a32c9fdda07013a034a

data/.gitignore

@@ -5,6 +5,9 @@ Makefile
 key.c
 video.c
 gl.c
+ttf.c
+mixer.c
+gamecontroller.c
 pkg/
 TAGS
 local/

data/README.md

@@ -5,22 +5,21 @@ The simple ruby extension library for SDL 2.x.
 # Install
 Before installing Ruby/SDL2, you need to install:
 
+* [devkit](http://rubyinstaller.org/add-ons/devkit/) (only for windows)
+* M4 (only for installing from git repository)
 * [SDL 2.x](http://www.libsdl.org/download-2.0.php)
 * [SDL_image](https://www.libsdl.org/projects/SDL_image/)
 * [SDL_mixer](https://www.libsdl.org/projects/SDL_mixer/)
 * [SDL_ttf](https://www.libsdl.org/projects/SDL_ttf/)
 
 After installing these libraries, you can install Ruby/SDL2
-from github
+from github:
 
     git clone https://github.com/ohai/ruby-sdl2.git
     cd ruby-sdl2
-    gem build rubysdl2.gem
-    gem install ruby-sdl2-x.y.z.gem
+    rake gem
+    gem install pkg/ruby-sdl2-x.y.z.gem
     
-## Install on Windows
-Please write this.
-
 # License
 
 LGPL v3 (see {file:COPYING.txt}).

data/Rakefile

@@ -10,6 +10,8 @@ RB_FILES = Dir.glob("lib/**/*.rb")
 POT_SOURCES = RB_FILES + ["main.c"] + (C_FILES - ["main.c"])
 YARD_SOURCES = "-m markdown --main README.md --files COPYING.txt #{POT_SOURCES.join(" ")}"
 
+WATCH_TARGETS = (C_FILES - C_FROM_M4_FILES) + C_M4_FILES + ["README.md"]
+  
 locale = ENV["YARD_LOCALE"]
 
 def extconf_options
@@ -77,6 +79,11 @@ task "doc-all" do
   raise "Not yet implemented"
 end
 
+desc "List undocumented classes/modules/methods/constants"
+task "doc-stat-undocumented" => POT_SOURCES do
+  sh "yard stats --list-undoc --compact #{YARD_SOURCES}"
+end
+
 rule ".c" => ".c.m4" do |t|
   sh "m4 #{t.prerequisites[0]} > #{t.name}"
 end
@@ -93,3 +100,9 @@ Gem::PackageTask.new(gem_spec) do |pkg|
 end
 
 rule ".gem" => C_FILES
+
+task "watch-doc" do
+  loop do
+    sh "inotifywait -e modify #{WATCH_TARGETS.join(" ")} && rake doc && notify-send -u low \"Ruby/SDL2 build doc OK\""
+  end
+end

data/clipboard.c

@@ -1,6 +1,19 @@
 #include "rubysdl2_internal.h"
 #include <SDL_clipboard.h>
 
+/*
+ * Document-module: SDL2::Clipboard
+ *
+ * This module has clipboard manipulating functions.
+ * 
+ */
+
+/*
+ * Get the text from the clipboard.
+ *
+ * @return [String] a string in the clipboard
+ * @return [nil] if the clipboard is empty
+ */ 
 static VALUE Clipboard_s_text(VALUE self)
 {
     if (SDL_HasClipboardText()) {
@@ -16,12 +29,23 @@ static VALUE Clipboard_s_text(VALUE self)
     }
 }
 
+/*
+ * @overload text=(text) 
+ *   Set the text in the clipboard.
+ *   
+ *   @param text [String] a new text
+ *   @return [String] text
+ */
 static VALUE Clipboard_s_set_text(VALUE self, VALUE text)
 {
     HANDLE_ERROR(SDL_SetClipboardText(StringValueCStr(text)));
     return text;
 }
 
+/*
+ * Return true if the clipboard has any text.
+ *
+ */
 static VALUE Clipboard_s_has_text_p(VALUE self)
 {
     return INT2BOOL(SDL_HasClipboardText());

data/event.c

@@ -33,6 +33,10 @@ static VALUE cEvControllerDevice;
 static VALUE cEvControllerDeviceAdded;
 static VALUE cEvControllerDeviceRemoved;
 static VALUE cEvControllerDeviceRemapped;
+static VALUE cEvTouchFinger;
+static VALUE cEvFingerDown;
+static VALUE cEvFingerUp;
+static VALUE cEvFingerMotion;
 /* static VALUE cEvUser; */
 /* static VALUE cEvDrop; */
 
@@ -137,7 +141,7 @@ static VALUE Event_s_enabled_p(VALUE self)
 }
 
 /*
- * @overload enabled=(bool)
+ * @overload enable=(bool)
  *   Set wheter the event is enable
  *   
  *   This method is only available for subclasses of SDL2::Event corresponding to
@@ -147,7 +151,7 @@ static VALUE Event_s_enabled_p(VALUE self)
  *     SDL2::Event::MouseWheel.enable = false
  *   
  *   @param [Boolean] bool true for enabling the event.
- *   @return [bool]
+ *   @return [Boolean]
  *   @see SDL2::Event.enabled?
  *
  */
@@ -198,6 +202,9 @@ static void set_string(char* field, VALUE str, int maxlength)
 #define EVENT_ACCESSOR_INT(classname, name, field) \
     EVENT_ACCESSOR(classname, name, field, NUM2INT, INT2NUM)
 
+#define EVENT_ACCESSOR_DBL(classname, name, field) \
+    EVENT_ACCESSOR(classname, name, field, NUM2DBL, DBL2NUM)
+
 #define EVENT_ACCESSOR_BOOL(classname, name, field)             \
     EVENT_ACCESSOR(classname, name, field, RTEST, INT2BOOL)
 
@@ -635,13 +642,13 @@ static VALUE EvMouseWheel_inspect(VALUE self)
  *
  * @attribute pressed
  *   button is pressed or not
- *   @return [Integer]
+ *   @return [Boolean]
  * 
  */
 EVENT_ACCESSOR_INT(JoyButton, which, jbutton.which);
 EVENT_ACCESSOR_UINT8(JoyButton, button, jbutton.button);
-EVENT_ACCESSOR_BOOL(JoyButton, pressed, jbutton.state)
-/* @return [Stirng] inspection string */
+EVENT_ACCESSOR_BOOL(JoyButton, pressed, jbutton.state);
+/* @return [String] inspection string */
 static VALUE EvJoyButton_inspect(VALUE self)
 {
     SDL_Event* ev; Data_Get_Struct(self, SDL_Event, ev);
@@ -765,6 +772,7 @@ static VALUE EvJoyHatMotion_inspect(VALUE self)
  *  {SDL2::Event::JoyDeviceRemoved joystick disconnected events}).
  */
 EVENT_ACCESSOR_INT(JoyDevice, which, jdevice.which);
+/* @return [String] inspection string */
 static VALUE EvJoyDevice_inspect(VALUE self)
 {
     SDL_Event* ev; Data_Get_Struct(self, SDL_Event, ev);
@@ -785,9 +793,27 @@ static VALUE EvJoyDevice_inspect(VALUE self)
  */
 
 
+/*
+ * Document-class: SDL2::Event::ControllerAxisMotion
+ *
+ * This class represents the {SDL2::GameController controller} axis motion events.
+ *
+ * @attribute which
+ *   the controller index
+ *   @return [Integer]
+ *
+ * @attribute axis
+ *   the axis index
+ *   @return [Integer]
+ *
+ * @attribute value
+ *   the axis value (range: -32768 to -32767, 0 for newtral)
+ *   @return [Integer]
+ */
 EVENT_ACCESSOR_INT(ControllerAxis, which, caxis.which);
 EVENT_ACCESSOR_UINT8(ControllerAxis, axis, caxis.axis);
 EVENT_ACCESSOR_INT(ControllerAxis, value, caxis.value);
+/* @return [String] inspection string */
 static VALUE ControllerAxis_inspect(VALUE self)
 {
     SDL_Event* ev; Data_Get_Struct(self, SDL_Event, ev);
@@ -798,9 +824,33 @@ static VALUE ControllerAxis_inspect(VALUE self)
                       ev->caxis.value);
 }
 
+/*
+ * Document-class: SDL2::Event::ControllerButton
+ *
+ * This class represents the {SDL2::GameController controller} button events.
+ *
+ * You don't handle the instance 
+ * of this class directly, but you handle the instances of 
+ * two subclasses of this subclasses:
+ * {SDL2::Event::ControllerButtonDown} and {SDL2::Event::ControllerButtonUp}.
+ *
+ * @attribute which
+ *   the controller index
+ *   @return [Integer]
+ *
+ * @attribute button
+ *   the controller button index
+ *   @return [Integer]
+ *
+ * @attribute pressed
+ *   button is pressed or not
+ *   @return [Boolean]
+ *
+ */
 EVENT_ACCESSOR_INT(ControllerButton, which, cbutton.which);
 EVENT_ACCESSOR_UINT8(ControllerButton, button, cbutton.button);
 EVENT_ACCESSOR_BOOL(ControllerButton, pressed, cbutton.state);
+/* @return [String] inspection string */
 static VALUE ControllerButton_inspect(VALUE self)
 {
     SDL_Event* ev; Data_Get_Struct(self, SDL_Event, ev);
@@ -811,8 +861,36 @@ static VALUE ControllerButton_inspect(VALUE self)
                       SDL_GameControllerGetStringForButton(ev->cbutton.button),
                       INT2BOOLCSTR(ev->cbutton.state));
 }
+/*
+ * Document-class: SDL2::Event::ControllerButtonDown
+ *
+ * This class represents the {SDL2::GameController controller} button press events.
+ */
 
+/*
+ * Document-class: SDL2::Event::ControllerButtonUp
+ *
+ * This class represents the {SDL2::GameController controller} button release events.
+ */
+
+/*
+ * Document-class: SDL2::Event::ControllerDevice
+ *
+ * This class represents {SDL2::GameController controller} device events (connected/disconnected/remapped).
+ *
+ * The event of this event doesn't occur. Only the event of the following subclasses
+ * occur in Ruby/SDL2.
+ *
+ *   * {SDL2::Event::ControllerDeviceAdded}
+ *   * {SDL2::Event::ControllerDeviceRemoved}
+ *   * {SDL2::Event::ControllerDeviceRemapped}
+ *
+ * @attribute which
+ *   the controller index
+ *   @return [Integer]
+ */
 EVENT_ACCESSOR_INT(ControllerDevice, which, cdevice.which);
+/* @return [String] inspection string */
 static VALUE ControllerDevice_inspect(VALUE self)
 {
     SDL_Event* ev; Data_Get_Struct(self, SDL_Event, ev);
@@ -821,6 +899,119 @@ static VALUE ControllerDevice_inspect(VALUE self)
                       ev->cdevice.which);
 }
 
+/*
+ * Document-class: SDL2::Event::ControllerDeviceAdded
+ *
+ * This class represents {SDL2::GameController controller} device connected events.
+ */
+/*
+ * Document-class: SDL2::Event::ControllerDeviceRemoved
+ *
+ * This class represents {SDL2::GameController controller} device disconnected events.
+ */
+/*
+ * Document-class: SDL2::Event::ControllerDeviceRemapped
+ *
+ * This class represents {SDL2::GameController controller} device remapped events.
+ */
+
+/*
+ * Document-class: SDL2::Event::TouchFinger
+ *
+ * This class represents touch finger events.
+ * 
+ * You don't handle the instance 
+ * of this class directly, but you handle the instances of 
+ * two subclasses of this subclasses:
+ * {SDL2::Event::FingerMotion} and {SDL2::Event::MouseButtonUp}.
+ *
+ * @attribute touch_id
+ *   the touch device id
+ *   @return [Integer]
+ *
+ * @attribute finger_id
+ *   the finger id
+ *   @return [Integer]
+ *
+ * @attribute x
+ *   the x-axis location of the touch event, normalized (0...1)
+ *   @return [Float]
+ *
+ * @attribute y
+ *   the y-axis location of the touch event, normalized (0...1)
+ *   @return [Float]
+ *
+ * @attribute pressure
+ *   the quantity of pressure applied, normalized (0...1)
+ *   @return [Float]
+ */
+EVENT_ACCESSOR_INT(TouchFinger, touch_id, tfinger.touchId);
+EVENT_ACCESSOR_INT(TouchFinger, finger_id, tfinger.fingerId);
+EVENT_ACCESSOR_DBL(TouchFinger, x, tfinger.x);
+EVENT_ACCESSOR_DBL(TouchFinger, y, tfinger.y);
+EVENT_ACCESSOR_DBL(TouchFinger, pressure, tfinger.pressure);
+/* @return [String] inspection string */
+static VALUE EvTouchFinger_inspect(VALUE self)
+{
+    SDL_Event* ev; Data_Get_Struct(self, SDL_Event, ev);
+    return rb_sprintf("<%s: type=%u timestamp=%u"
+                      " touch_id=%d finger_id=%d"
+                      " x=%f y=%f pressure=%f>",
+                      rb_obj_classname(self), ev->common.type, ev->common.timestamp,
+                      (int)ev->tfinger.touchId, (int)ev->tfinger.fingerId,
+                      ev->tfinger.x, ev->tfinger.y, ev->tfinger.pressure);
+}
+
+/*
+ * Document-class: SDL2::Event::FingerUp
+ * This class represents finger touch events.
+ */
+/*
+ * Document-class: SDL2::Event::FingerDown
+ * This class represents finger release events.
+ */
+
+/*
+ * Document-class: SDL2::Event::FingerMotion
+ *
+ * This class represents touch move events.
+ *
+ * @attribute dx
+ *   the distance moved in the x-axis, normalized (0...1)
+ *   @return [Float]
+ *
+ * @attribute dy
+ *   the distance moved in the x-axis, normalized (0...1)
+ *   @return [Float]
+ *
+ */
+EVENT_ACCESSOR_DBL(FingerMotion, dx, tfinger.dx);
+EVENT_ACCESSOR_DBL(FingerMotion, dy, tfinger.dy);
+/* @return [String] inspection string */
+static VALUE EvFingerMotion_inspect(VALUE self)
+{
+    SDL_Event* ev; Data_Get_Struct(self, SDL_Event, ev);
+    return rb_sprintf("<%s: type=%u timestamp=%u"
+                      " touch_id=%d finger_id=%d"
+                      " x=%f y=%f pressure=%f"
+                      " dy=%f dx=%f>",
+                      rb_obj_classname(self), ev->common.type, ev->common.timestamp,
+                      (int) ev->tfinger.touchId, (int) ev->tfinger.fingerId,
+                      ev->tfinger.x, ev->tfinger.y, ev->tfinger.pressure,
+                      ev->tfinger.dx, ev->tfinger.dx);
+}
+
+/*
+ * Document-class: SDL2::Event::SysWM
+ *
+ * This class represents video driver dependent system events.
+ *
+ * This event is disabled by default. You can enable it with {SDL2::Event.enable=}.
+ * This event is now useless because now there is no way to get
+ * driver dependent information from this event class.
+ * You are encouraged to avoid this event.
+ * 
+ */
 static void connect_event_class(SDL_EventType type, VALUE klass)
 {
     event_type_to_class[type] = klass;
@@ -856,6 +1047,9 @@ static void init_event_type_to_class(void)
     connect_event_class(SDL_CONTROLLERDEVICEADDED, cEvControllerDeviceAdded);
     connect_event_class(SDL_CONTROLLERDEVICEREMOVED, cEvControllerDeviceRemoved);
     connect_event_class(SDL_CONTROLLERDEVICEREMAPPED, cEvControllerDeviceRemapped);
+    connect_event_class(SDL_FINGERDOWN, cEvFingerDown);
+    connect_event_class(SDL_FINGERUP, cEvFingerUp);
+    connect_event_class(SDL_FINGERMOTION, cEvFingerMotion);
 }
 
 #define DEFINE_EVENT_READER(classname, classvar, name)                  \
@@ -908,6 +1102,12 @@ void rubysdl2_init_event(void)
     cEvControllerDeviceAdded = rb_define_class_under(cEvent, "ControllerDeviceAdded", cEvControllerDevice);
     cEvControllerDeviceRemoved = rb_define_class_under(cEvent, "ControllerDeviceRemoved", cEvControllerDevice);
     cEvControllerDeviceRemapped = rb_define_class_under(cEvent, "ControllerDeviceRemapped", cEvControllerDevice);
+    cEvTouchFinger = rb_define_class_under(cEvent, "TouchFinger", cEvent);
+    cEvFingerUp = rb_define_class_under(cEvent, "FingerUp", cEvTouchFinger);
+    cEvFingerDown = rb_define_class_under(cEvent, "FingerDown", cEvTouchFinger);
+    cEvFingerMotion = rb_define_class_under(cEvent, "FingerMotion", cEvTouchFinger);
+    
+    
     
     DEFINE_EVENT_READER(Event, cEvent, type);
     DEFINE_EVENT_ACCESSOR(Event, cEvent, timestamp);
@@ -1022,6 +1222,17 @@ void rubysdl2_init_event(void)
 
     DEFINE_EVENT_ACCESSOR(ControllerDevice, cEvControllerDevice, which);
     rb_define_method(cEvControllerDevice, "inspect", ControllerDevice_inspect, 0);
+
+    DEFINE_EVENT_ACCESSOR(TouchFinger, cEvTouchFinger, touch_id);
+    DEFINE_EVENT_ACCESSOR(TouchFinger, cEvTouchFinger, finger_id);
+    DEFINE_EVENT_ACCESSOR(TouchFinger, cEvTouchFinger, x); 
+    DEFINE_EVENT_ACCESSOR(TouchFinger, cEvTouchFinger, y);
+    DEFINE_EVENT_ACCESSOR(TouchFinger, cEvTouchFinger, pressure);
+    rb_define_method(cEvTouchFinger, "inspect", EvTouchFinger_inspect, 0);
+
+    DEFINE_EVENT_ACCESSOR(FingerMotion, cEvFingerMotion, dx); 
+    DEFINE_EVENT_ACCESSOR(FingerMotion, cEvFingerMotion, dy);
+    rb_define_method(cEvFingerMotion, "inspect", EvFingerMotion_inspect, 0);
     
     init_event_type_to_class();
 }

data/filesystem.c

@@ -2,6 +2,16 @@
 #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();
@@ -13,6 +23,23 @@ static VALUE SDL2_s_base_path(VALUE self)
     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));