ruby-sdl2 0.1.0

data/lib/sdl2.rb

@@ -0,0 +1,3 @@
+require 'sdl2_ext'
+require 'sdl2/version'
+

data/lib/sdl2/version.rb

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

data/main.c

@@ -0,0 +1,244 @@
+#define SDL2_EXTERN
+#include "rubysdl2_internal.h"
+#include <SDL.h>
+#include <SDL_version.h>
+#include <stdio.h>
+#ifdef HAVE_SDL_IMAGE_H
+#include <SDL_image.h>
+#endif
+#ifdef HAVE_SDL_MIXER_H
+#include <SDL_mixer.h>
+#endif
+#ifdef HAVE_SDL_TTF_H
+#include <SDL_ttf.h>
+#endif
+#include <stdarg.h>
+#include <ruby/encoding.h>
+
+int rubysdl2_handle_error(int code, const char* cfunc)
+{
+    VALUE err;
+    char err_msg[1024];
+  
+    if (code >= 0)
+        return code;
+
+    snprintf(err_msg, sizeof(err_msg), "%s (cfunc=%s)", SDL_GetError(), cfunc);
+    err = rb_exc_new2(eSDL2Error, err_msg);
+    rb_iv_set(eSDL2Error, "@error_code", INT2NUM(code));
+  
+    rb_exc_raise(err);
+}
+
+void rubysdl2_define_attr_readers(VALUE klass, ...)
+{
+    va_list ap;
+
+    va_start(ap, klass);
+    for (;;) {
+        const char* field_name = va_arg(ap, const char*);
+        if (field_name == NULL)
+            break;
+        rb_define_attr(klass, field_name, 1, 0);
+    }
+    va_end(ap);
+}
+
+VALUE utf8str_new_cstr(const char* str)
+{
+    return rb_enc_str_new(str, strlen(str), rb_utf8_encoding());
+}
+
+VALUE SDL_version_to_String(const SDL_version* ver)
+{
+    return rb_sprintf("%d.%d.%d", ver->major, ver->minor, ver->patch);
+}
+
+VALUE SDL_version_to_Array(const SDL_version* ver)
+{
+    return rb_ary_new3(3, INT2FIX(ver->major), INT2FIX(ver->minor), INT2FIX(ver->patch));
+}
+
+const char* INT2BOOLCSTR(int n)
+{
+    return n ? "true" : "false";
+}
+
+typedef enum {
+    NOT_INITIALIZED, INITIALIZDED, FINALIZED
+} sdl2_state;
+
+static sdl2_state state = NOT_INITIALIZED;
+
+static void quit(VALUE unused)
+{
+    if (state != INITIALIZDED)
+        return;
+    
+#ifdef HAVE_SDL_IMAGE_H
+    IMG_Quit();
+#endif
+#ifdef HAVE_SDL_MIXER_H
+    Mix_Quit();
+#endif
+#ifdef HAVE_SDL_TTF_H
+    TTF_Quit();
+#endif
+    SDL_VideoQuit();
+    SDL_Quit();
+    state = FINALIZED;
+}
+
+/*
+ * Initialize SDL.
+ * You must call this function before using any other Ruby/SDL2 methods.
+ * 
+ * You can specify initialized subsystem by flags which is
+ * bitwise OR of the following constants:
+ * 
+ * * SDL2::INIT_TIMER - timer subsystem
+ * * SDL2::INIT_AUDIO - audio subsystem
+ * * SDL2::INIT_VIDEO - video subsystem
+ * * SDL2::INIT_JOYSTICK - joystick subsystem
+ * * SDL2::INIT_HAPTIC - haptic (force feedback) subsystem
+ *     (interface is not implemented yet)
+ * * SDL2::INIT_GAMECONTROLLER - controller subsystem
+ * * SDL2::INIT_EVENTS - events subsystem
+ * * SDL2::INIT_EVERYTHING - all of the above flags
+ * * SDL2::INIT_NOPARACHUTE - this flag is ignored; for compatibility
+ *
+ * @overload init(flags)
+ * 
+ *   @param [Integer] flags initializing subsystems
+ *   
+ * @return [nil]
+ */
+static VALUE SDL2_s_init(VALUE self, VALUE flags)
+{
+    SDL_SetMainReady();
+    HANDLE_ERROR(SDL_Init(NUM2UINT(flags)));
+    state = INITIALIZDED;
+    return Qnil;
+}
+
+int rubysdl2_is_active(void)
+{
+    return state == INITIALIZDED;
+}
+
+static VALUE libsdl_version(void)
+{
+    SDL_version version;
+    SDL_GetVersion(&version);
+    return SDL_version_to_String(&version);
+}
+
+static VALUE libsdl_version_number(void)
+{
+    SDL_version version;
+    SDL_GetVersion(&version);
+    return SDL_version_to_Array(&version);
+}
+
+static VALUE libsdl_revision(void)
+{
+    return rb_usascii_str_new_cstr(SDL_GetRevision());
+}
+
+static VALUE libsdl_revision_number(void)
+{
+    return INT2NUM(SDL_GetRevisionNumber());
+}
+
+/*
+ * Document-module: SDL2
+ *
+ * Namespace module for Ruby/SDL2.
+ *
+ */
+
+/*
+ * Document-class: SDL2::Error
+ *
+ * An exception class for all Ruby/SDL2 specific errors.
+ *
+ * @attribute [r] error_code
+ *   @return [Integer] error code sent from SDL library
+ */
+void Init_sdl2_ext(void)
+{
+    mSDL2 = rb_define_module("SDL2");
+
+    rb_define_module_function(mSDL2, "init", SDL2_s_init, 1);
+#define DEFINE_SDL_INIT_CONST(type)                                     \
+    rb_define_const(mSDL2, "INIT_" #type, UINT2NUM(SDL_INIT_##type))
+  
+    DEFINE_SDL_INIT_CONST(TIMER);
+    DEFINE_SDL_INIT_CONST(AUDIO);
+    DEFINE_SDL_INIT_CONST(VIDEO);
+    DEFINE_SDL_INIT_CONST(JOYSTICK);
+    DEFINE_SDL_INIT_CONST(HAPTIC);
+    DEFINE_SDL_INIT_CONST(GAMECONTROLLER);
+    DEFINE_SDL_INIT_CONST(EVENTS);
+    DEFINE_SDL_INIT_CONST(EVERYTHING);
+    DEFINE_SDL_INIT_CONST(NOPARACHUTE);
+
+    /* SDL's version string  */
+    rb_define_const(mSDL2, "LIBSDL_VERSION", libsdl_version());
+    /* SDL's version array of numbers  */
+    rb_define_const(mSDL2, "LIBSDL_VERSION_NUMBER", libsdl_version_number());
+    /* SDL's revision (from VCS) string  */
+    rb_define_const(mSDL2, "LIBSDL_REVISION", libsdl_revision());
+    /* SDL's revision (from VCS) array of numbers  */
+    rb_define_const(mSDL2, "LIBSDL_REVISION_NUMBER", libsdl_revision_number());
+
+#ifdef HAVE_SDL_IMAGE_H
+    {
+        const SDL_version* version = IMG_Linked_Version();
+        /* SDL_image's version string, only available if SDL_image is linked */
+        rb_define_const(mSDL2, "LIBSDL_IMAGE_VERSION", SDL_version_to_String(version));
+        /* SDL_image's version array of numbers */
+        rb_define_const(mSDL2, "LIBSDL_IMAGE_VERSION_NUMBER", SDL_version_to_Array(version));
+    }
+#endif
+#ifdef HAVE_SDL_TTF_H
+    {
+        const SDL_version* version = TTF_Linked_Version();
+        /* SDL_ttf's version string, only available if SDL_ttf is linked */
+        rb_define_const(mSDL2, "LIBSDL_TTF_VERSION", SDL_version_to_String(version));
+        /* SDL_ttf's version array of numbers */
+        rb_define_const(mSDL2, "LIBSDL_TTF_VERSION_NUMBER", SDL_version_to_Array(version));
+    }
+#endif
+#ifdef HAVE_SDL_MIXER_H
+    {
+        const SDL_version* version = Mix_Linked_Version();
+        /* SDL_mixer's version string , only available if SDL_mixer is linked */
+        rb_define_const(mSDL2, "LIBSDL_MIXER_VERSION", SDL_version_to_String(version));
+        /* SDL_mixer's version array of numbers */
+        rb_define_const(mSDL2, "LIBSDL_MIXER_VERSION_NUMBER", SDL_version_to_Array(version));
+    }
+#endif
+    
+    eSDL2Error = rb_define_class_under(mSDL2, "Error", rb_eStandardError);
+    rb_define_attr(eSDL2Error, "error_code", 1, 0);
+
+    rubysdl2_init_hints();
+    rubysdl2_init_video();
+    rubysdl2_init_gl();
+    rubysdl2_init_messagebox();
+    rubysdl2_init_event();
+    rubysdl2_init_key();
+    rubysdl2_init_mouse();
+    rubysdl2_init_joystick();
+    rubysdl2_init_gamecontorller();
+    rubysdl2_init_timer();
+    rubysdl2_init_image();
+    rubysdl2_init_mixer();
+    rubysdl2_init_ttf();
+    rubysdl2_init_filesystem();
+    rubysdl2_init_clipboard();
+    
+    rb_set_end_proc(quit, 0);
+    return;
+}

data/messagebox.c

@@ -0,0 +1,231 @@
+#include "rubysdl2_internal.h"
+#include <SDL_messagebox.h>
+
+static VALUE sym_flags, sym_window, sym_title, sym_message, sym_buttons, sym_color_scheme,
+    sym_id, sym_text, sym_bg, sym_button_border, sym_button_bg, sym_button_selected;
+
+static inline SDL_Window* Get_SDL_Window_or_NULL(VALUE win)
+{
+    if (win == Qnil)
+        return NULL;
+    else
+        return Get_SDL_Window(win);
+}
+
+/*
+ * @overload show_simple_message_box(flag, title, message, parent)
+ *   Create a simple modal message box.
+ *
+ *   This function pauses all ruby's threads and
+ *   the threads are resumed when modal dialog is closed.
+ *   
+ *   You can create a message box before calling {SDL2.init}.
+ *   
+ *   You specify one of the following constants as flag
+ *
+ *   * {SDL2::MESSAGEBOX_ERROR}
+ *   * {SDL2::MESSAGEBOX_WARNING}
+ *   * {SDL2::MESSAGEBOX_INFORMATION}
+ *
+ *   @example show warning dialog
+ *   
+ *       SDL2.show_simple_message_box(SDL2::MESSAGEBOX_WARNING, "warning!",
+ *                                    "Somewhat special warning message!!", nil)
+ *                                
+ *   @param [Integer] flag one of the above flags
+ *   @param [String] title title text
+ *   @param [String] message message text
+ *   @param [SDL2::Window,nil] parent the parent window, or nil for no parent
+ *   @return [nil]
+ *   
+ *   @see .show_message_box
+ */
+static VALUE SDL2_s_show_simple_message_box(VALUE self, VALUE flag, VALUE title,
+                                            VALUE message, VALUE parent)
+{
+    title = rb_str_export_to_utf8(title);
+    message = rb_str_export_to_utf8(message);
+    HANDLE_ERROR(SDL_ShowSimpleMessageBox(NUM2UINT(flag),
+                                          StringValueCStr(title),
+                                          StringValueCStr(message),
+                                          Get_SDL_Window_or_NULL(parent)));
+    return Qnil;
+}
+
+static void set_color_scheme(VALUE colors, VALUE sym, SDL_MessageBoxColor* color)
+{
+    VALUE c = rb_hash_aref(colors, sym);
+    Check_Type(c, T_ARRAY);
+    color->r = NUM2UCHAR(rb_ary_entry(c, 0));
+    color->g = NUM2UCHAR(rb_ary_entry(c, 1));
+    color->b = NUM2UCHAR(rb_ary_entry(c, 2));
+}
+
+/*
+ * @overload show_message_box(flag:, window: nil, title:, message:, buttons:, color_scheme: nil)
+ *   Create a model message box.
+ *
+ *   You specify one of the following constants as flag
+ *
+ *   * {SDL2::MESSAGEBOX_ERROR}
+ *   * {SDL2::MESSAGEBOX_WARNING}
+ *   * {SDL2::MESSAGEBOX_INFORMATION}
+ *
+ *   One button in the dialog represents a hash with folloing elements.
+ *   
+ *       { flags: 0, SDL2::MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT, or
+ *                SDL2::MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT,
+ *                you can ignore it for 0,
+ *         text: text of a button,
+ *         id: index of the button
+ *       }
+ *
+ *   and buttons is an array of above button hashes.
+ *
+ *   You can specify the color of message box by color_scheme.
+ *   color_scheme is an hash whose keys are :bg, :text, :button_border, :button_bg,
+ *   and :button_selected and values are array of three integers representing
+ *   color.
+ *   You can also use default color scheme by giving nil.
+ *   
+ *   
+ *   This function pauses all ruby's threads until
+ *   the modal dialog is closed.
+ *   
+ *   You can create a message box before calling {SDL2.init}.
+ *
+ *   @example show a dialog with 3 buttons
+ *       button = SDL2.show_message_box(flags: SDL2::MESSAGEBOX_WARNING,
+ *                                      window: nil,
+ *                                      title: "Warning window",
+ *                                      message: "Here is the warning message",
+ *                                      buttons: [ { # flags is ignored
+ *                                                  id: 0, 
+ *                                                  text: "No",
+ *                                                 }, 
+ *                                                 {flags: SDL2::MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT,
+ *                                                  id: 1,
+ *                                                  text: "Yes",
+ *                                                 },
+ *                                                 {flags: SDL2::MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT,
+ *                                                  id: 2,
+ *                                                  text: "Cancel",
+ *                                                 },
+ *                                               ],
+ *                                      color_scheme: {
+ *                                                     bg: [255, 0, 0],
+ *                                                     text: [0, 255, 0],
+ *                                                     button_border: [255, 0, 0],
+ *                                                     button_bg: [0, 0, 255],
+ *                                                     button_selected: [255, 0, 0]
+ *                                                    }
+ *                                     )
+ *                                 
+ *   @param [Integer] flags message box type flag
+ *   @param [SDL2::Window,nil] window the parent window, or nil for no parent
+ *   @param [String] title the title text
+ *   @param [String] message the message text
+ *   @param [Array<Hash<Symbol => Object>>] buttons array of buttons
+ *   @param [Hash<Symbol=>[Integer,Integer,Integer]> nil] color_scheme
+ *       color scheme, or nil for the default color scheme
+ *   @return [Integer] pressed button id
+ *   
+ *   @see .show_simple_message_box
+ */
+static VALUE SDL2_s_show_message_box(VALUE self, VALUE params)
+{
+    SDL_MessageBoxData mb_data;
+    VALUE title, message, texts, buttons, color_scheme;
+    long num_buttons;
+    int i;
+    SDL_MessageBoxButtonData* button_data;
+    SDL_MessageBoxColorScheme scheme;
+    int buttonid;
+
+    Check_Type(params, T_HASH);
+    mb_data.flags = NUM2INT(rb_hash_aref(params, sym_flags));
+    mb_data.window = Get_SDL_Window_or_NULL(rb_hash_aref(params, sym_window));
+    title = rb_str_export_to_utf8(rb_hash_aref(params, sym_title));
+    mb_data.title = StringValueCStr(title);
+    message = rb_str_export_to_utf8(rb_hash_aref(params, sym_message));
+    mb_data.message = StringValueCStr(message);
+    
+    buttons = rb_hash_aref(params, sym_buttons);
+    Check_Type(buttons, T_ARRAY);
+    mb_data.numbuttons = num_buttons = RARRAY_LEN(buttons);
+    button_data = ALLOCA_N(SDL_MessageBoxButtonData, num_buttons);
+    mb_data.buttons = button_data;
+    texts = rb_ary_new2(num_buttons);
+    
+    for (i=0; i<num_buttons; ++i) {
+        VALUE button = rb_ary_entry(buttons, i);
+        VALUE flags = rb_hash_aref(button, sym_flags);
+        VALUE text;
+        if (flags == Qnil)
+            button_data[i].flags = 0;
+        else
+            button_data[i].flags = NUM2INT(flags);
+        text = rb_str_export_to_utf8(rb_hash_aref(button, sym_text));
+        rb_ary_push(texts, text);
+        button_data[i].buttonid = NUM2INT(rb_hash_aref(button, sym_id));
+        button_data[i].text = StringValueCStr(text);
+    }
+
+    color_scheme = rb_hash_aref(params, sym_color_scheme);
+    if (color_scheme == Qnil) {
+        mb_data.colorScheme = NULL;
+    } else {
+        Check_Type(color_scheme, T_HASH);
+        mb_data.colorScheme = &scheme;
+        set_color_scheme(color_scheme, sym_bg, &scheme.colors[0]);
+        set_color_scheme(color_scheme, sym_text, &scheme.colors[1]);
+        set_color_scheme(color_scheme, sym_button_border, &scheme.colors[2]);
+        set_color_scheme(color_scheme, sym_button_bg, &scheme.colors[3]);
+        set_color_scheme(color_scheme, sym_button_selected, &scheme.colors[4]);
+    }
+    
+    HANDLE_ERROR(SDL_ShowMessageBox(&mb_data, &buttonid));
+    
+    RB_GC_GUARD(title); RB_GC_GUARD(message); RB_GC_GUARD(texts);
+    return INT2NUM(buttonid);
+}
+
+void rubysdl2_init_messagebox(void)
+{
+    rb_define_singleton_method(mSDL2, "show_simple_message_box",
+                               SDL2_s_show_simple_message_box, 4);
+    rb_define_singleton_method(mSDL2, "show_message_box", SDL2_s_show_message_box, 1);
+    /* This flag means that the message box shows an error message in
+     * {SDL2.show_simple_message_box} and {SDL2.show_message_box}.
+     */
+    rb_define_const(mSDL2, "MESSAGEBOX_ERROR", INT2NUM(SDL_MESSAGEBOX_ERROR));
+    /* This flag means that the message box shows a warning message in
+     * {SDL2.show_simple_message_box} and {SDL2.show_message_box}.
+     */
+    rb_define_const(mSDL2, "MESSAGEBOX_WARNING", INT2NUM(SDL_MESSAGEBOX_WARNING));
+    /* This flag means that the message box shows an informational message in
+     * {SDL2.show_simple_message_box} and {SDL2.show_message_box}.
+     */
+    rb_define_const(mSDL2, "MESSAGEBOX_INFORMATION", INT2NUM(SDL_MESSAGEBOX_INFORMATION));
+    /* This flag represents the button is selected when return key is pressed in
+     * {SDL2.show_message_box}. */
+    rb_define_const(mSDL2, "MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT",
+                    INT2NUM(SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT));
+    /* This flag represents the button is selected when escape key is pressed in
+     * {SDL2.show_message_box}. */
+    rb_define_const(mSDL2, "MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT",
+                    INT2NUM(SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT));
+
+    sym_flags = ID2SYM(rb_intern("flags"));
+    sym_window =  ID2SYM(rb_intern("window"));
+    sym_message = ID2SYM(rb_intern("message"));
+    sym_title = ID2SYM(rb_intern("title"));
+    sym_buttons = ID2SYM(rb_intern("buttons"));
+    sym_color_scheme = ID2SYM(rb_intern("color_scheme"));
+    sym_id = ID2SYM(rb_intern("id"));
+    sym_text = ID2SYM(rb_intern("text"));
+    sym_bg = ID2SYM(rb_intern("bg"));
+    sym_button_border = ID2SYM(rb_intern("button_border"));
+    sym_button_bg = ID2SYM(rb_intern("button_bg"));
+    sym_button_selected = ID2SYM(rb_intern("button_selected"));
+}