rb_sdl2 0.1.0

data/lib/rb_sdl2/mouse.rb

@@ -0,0 +1,74 @@
+module RbSDL2
+  module Mouse
+    class << self
+      def capture=(bool)
+        err = ::SDL2.SDL_CaptureMouse(bool ? ::SDL2::SDL_TRUE : ::SDL2::SDL_FALSE)
+        raise RbSDL2Error if err < 0
+      end
+
+      def relative=(bool)
+        err = ::SDL2.SDL_SetRelativeMouseMode(bool ? ::SDL2::SDL_TRUE : ::SDL2::SDL_FALSE)
+        raise RbSDL2Error if err < 0
+      end
+
+      def relative? = ::SDL2.SDL_GetRelativeMouseMode == ::SDL2::SDL_TRUE
+    end
+
+    require 'forwardable'
+    extend SingleForwardable
+
+    class << self
+      require_relative 'mouse/global_mouse'
+
+      def global_mouse = GlobalMouse.instance
+    end
+
+    def_single_delegator "global_mouse.update", :position, :global_position
+    def_single_delegator "global_mouse.update", :position=, :global_position=
+    def_single_delegator "global_mouse.update", :x, :global_x
+    def_single_delegator "global_mouse.update", :y, :global_y
+
+    class << self
+      require_relative 'mouse/mouse_wheel'
+
+      def mouse_wheel = MouseWheel.instance
+    end
+
+    def_single_delegator "mouse_wheel.update", :position, :wheel_position
+    def_single_delegator "Mouse::MouseWheel", :wheel=
+    def_single_delegator "mouse_wheel.update", :x, :wheel_x
+    def_single_delegator "mouse_wheel.update", :y, :wheel_y
+
+    class << self
+      require_relative 'mouse/relative_mouse'
+
+      def relative_mouse = RelativeMouse.instance
+
+      def relative_position=(rx_ry)
+        rx, ry = rx_ry
+        px, py = position
+        self.position = [px + rx, py + ry]
+      end
+    end
+
+    def_single_delegator "relative_mouse.update", :position, :relative_position
+    def_single_delegator "relative_mouse.update", :x, :relative_x
+    def_single_delegator "relative_mouse.update", :y, :relative_y
+
+    class << self
+      require_relative 'mouse/window_mouse'
+
+      def window_mouse = WindowMouse.instance
+    end
+
+    def_single_delegator "window_mouse.update", :button
+
+    require_relative 'mouse/mouse_button'
+    extend MouseButton
+
+    def_single_delegator "window_mouse.update", :position
+    def_single_delegator "window_mouse.update", :position=
+    def_single_delegator "window_mouse.update", :x
+    def_single_delegator "window_mouse.update", :y
+  end
+end

data/lib/rb_sdl2/palette.rb

@@ -0,0 +1,70 @@
+module RbSDL2
+  class Palette
+    require_relative 'ref_count_pointer'
+
+    class PalettePointer < RefCountPointer
+      class << self
+        def release(ptr) = ::SDL2.SDL_FreePalette(ptr)
+
+        def entity_class = ::SDL2::SDL_Palette
+      end
+    end
+
+    class << self
+      def [](*color)
+        plt = new(color.length)
+        color.each.with_index { |c, nth| plt[nth] = c }
+        plt
+      end
+
+      def new(num_colors)
+        ptr = PalettePointer.new(::SDL2.SDL_AllocPalette(num_colors))
+        raise RbSDL2Error if ptr.null?
+        super(ptr)
+      end
+
+      def to_ptr(ptr)
+        obj = allocate
+        obj.__send__(:initialize, PalettePointer.to_ptr(ptr))
+        obj
+      end
+    end
+
+    def initialize(ptr)
+      @st = ::SDL2::SDL_Palette.new(ptr)
+    end
+
+    def ==(other)
+      other.respond_to?(:to_ptr) && to_ptr == other.to_ptr
+    end
+
+    def [](nth)
+      raise ArgumentError if nth < 0 || length <= nth
+      ::SDL2::SDL_Color.new(@st[:colors] + ::SDL2::SDL_Color.size * nth).values
+    end
+
+    # color 引数には ３要素以上の配列であること。４要素目以降は無視される。
+    # color 引数は内部で splat する。これに対応していれば配列以外のオブジェクトでもよい。
+    # パレットのカラーが描画に使われるときはアルファ値は無視されて不透明(SDL_ALPHA_OPAQUE)として扱わられる。
+    # パレットのカラーは作成時に全て [255, 255, 255, 255] で埋められている。
+    def []=(nth, color)
+      raise ArgumentError if nth < 0 || length <= nth
+      c = ::SDL2::SDL_Color.new
+      c[:r], c[:g], c[:b] = color
+      err = ::SDL2.SDL_SetPaletteColors(self, c, nth, 1)
+      raise RbSDL2Error if err < 0
+    end
+
+    def each = length.times { |nth| yield(self[nth]) }
+
+    def length = @st[:ncolors]
+
+    alias size length
+
+    def to_a = to_enum.to_a
+
+    def to_ptr = @st.to_ptr
+
+    def version = @st[:version]
+  end
+end

data/lib/rb_sdl2/pixel_format_enum.rb

@@ -0,0 +1,73 @@
+module RbSDL2
+  module PixelFormatEnum
+    names = ::SDL2.constants.grep(/\ASDL_PIXELFORMAT_/)
+    values = names.map { |n| ::SDL2.const_get(n) }
+    FORMAT_MAP = names.zip(values).to_h.freeze
+
+    INDEXED_TYPES = [::SDL2::SDL_PIXELTYPE_INDEX1, ::SDL2::SDL_PIXELTYPE_INDEX4,
+                     ::SDL2::SDL_PIXELTYPE_INDEX8].freeze
+
+    PACKED_TYPES = [::SDL2::SDL_PIXELTYPE_PACKED8, ::SDL2::SDL_PIXELTYPE_PACKED16,
+                    ::SDL2::SDL_PIXELTYPE_PACKED32].freeze
+
+    ARRAY_TYPES = [::SDL2::SDL_PIXELTYPE_ARRAYU8, ::SDL2::SDL_PIXELTYPE_ARRAYU16,
+                   ::SDL2::SDL_PIXELTYPE_ARRAYU32, ::SDL2::SDL_PIXELTYPE_ARRAYF16,
+                   ::SDL2::SDL_PIXELTYPE_ARRAYF32].freeze
+
+    PACKED_ORDERS = [::SDL2::SDL_PACKEDORDER_ARGB, ::SDL2::SDL_PACKEDORDER_RGBA,
+                     ::SDL2::SDL_PACKEDORDER_ABGR, ::SDL2::SDL_PACKEDORDER_BGRA].freeze
+
+    ARRAY_ORDERS = [::SDL2::SDL_ARRAYORDER_ARGB, ::SDL2::SDL_ARRAYORDER_RGBA,
+                    ::SDL2::SDL_ARRAYORDER_ABGR, ::SDL2::SDL_ARRAYORDER_BGRA].freeze
+
+    class << self
+      def array_type?(num) = !fourcc?(num) && ARRAY_TYPES.include?(to_type(num))
+
+      def fourcc?(num) = (num >> 28) & 0x0F != 1
+
+      def indexed_type?(num) = !fourcc?(num) && INDEXED_TYPES.include?(to_type(num))
+
+      def packed_type?(num) = !fourcc?(num) && PACKED_TYPES.include?(to_type(num))
+
+      def to_fourcc(num)
+        4.times.inject([]) { |n, i| n << (num >> i * 8) % 0x100 }.pack("c4") if fourcc?
+      end
+
+      def to_name(num) = ::SDL2.SDL_GetPixelFormatName(num).read_string
+
+      # obj は SDL の SDL_PIXELFORMAT_* 定数のどれか、または定数名でもよい。
+      # 定数名は RGBA32 のような短縮した名前でもよい。"UNKNOWN" も受け取れる（値は 0）。
+      # 該当するフォーマットがない場合は 0 (SDL_PIXELFORMAT_UNKNOWN) を戻す。
+      # SDL はオリジナルのフォーマットを処理しないことに注意。
+      def to_num(obj)
+        name = if Symbol === obj || String === obj
+                 obj.match?(/\ASDL_PIXELFORMAT_/) ? obj : "SDL_PIXELFORMAT_#{obj.upcase}"
+               else
+                 to_name(obj)
+               end
+        FORMAT_MAP[name.to_sym].to_i
+      end
+
+      def to_order(num) = fourcc?(num) ? 0 : (num >> 20) & 0x0F
+
+      def to_type(num) = fourcc?(num) ? 0 : (num >> 24) & 0x0F
+
+      def with_alpha?(num)
+        packed_type?(num) && PACKED_ORDERS.include?(to_order(num)) ||
+          array_type?(num) && ARRAY_ORDERS.include?(to_order(num))
+      end
+    end
+
+    def fourcc = PixelFormatEnum.to_fourcc(format)
+
+    def fourcc? = PixelFormatEnum.fourcc?(format)
+
+    def format_name = PixelFormatEnum.to_name(format)
+
+    def indexed_color? = PixelFormatEnum.indexed_type?(format)
+
+    def rgb? = !(fourcc? || indexed_color? || rgba?)
+
+    def rgba? = PixelFormatEnum.with_alpha?(format)
+  end
+end

data/lib/rb_sdl2/platform.rb

@@ -0,0 +1,7 @@
+module RbSDL2
+  module Platform
+    class << self
+      def platform = ::SDL2.SDL_GetPlatform.read_string
+    end
+  end
+end

data/lib/rb_sdl2/power_info.rb

@@ -0,0 +1,36 @@
+module RbSDL2
+  module PowerInfo
+    @secs_ptr, @pct_ptr = Array.new(2) { ::FFI::MemoryPointer.new(:int) }
+
+    class << self
+      attr_reader :battery_capacity, :battery_time, :state
+
+      # バッテリーが搭載されているか？
+      def battery? = on_battery? || battery_charging? || battery_charged?
+
+      # 電源あり、バッテリー満充電
+      def battery_charged? = ::SDL2::SDL_POWERSTATE_CHARGED == state
+
+      # 電源あり、バッテリー充電中
+      def battery_charging? = ::SDL2::SDL_POWERSTATE_CHARGING == state
+
+      # 電源あり、バッテリー非搭載（デスクトップパソコンなど）
+      def no_battery? = ::SDL2::SDL_POWERSTATE_NO_BATTERY == state
+
+      # 電源なし、バッテリー使用中
+      def on_battery? = ::SDL2::SDL_POWERSTATE_ON_BATTERY == state
+
+      # 電源に接続されているか？
+      def plugged_in? = no_battery? || battery_charging? || battery_charged?
+
+      def update
+        @state = ::SDL2.SDL_GetPowerInfo(@secs_ptr, @pct_ptr)
+        @battery_time, @battery_capacity = @secs_ptr.read_int, @pct_ptr.read_int
+        self
+      end
+
+      # 電源、バッテリーの情報なし
+      def unknown? = ::SDL2::SDL_POWERSTATE_UNKNOWN == state
+    end
+  end
+end

data/lib/rb_sdl2/rect.rb

@@ -0,0 +1,14 @@
+module RbSDL2
+  class Rect
+    def initialize(x = 0, y = 0, w = 0, h = 0)
+      @st = ::SDL2::SDL_Rect.new
+      @st[:x], @st[:y], @st[:w], @st[:h] = x, y, w, h
+    end
+
+    def to_a = @st.values
+
+    alias to_ary to_a
+
+    def to_ptr = @st.to_ptr
+  end
+end

data/lib/rb_sdl2/ref_count_pointer.rb

@@ -0,0 +1,20 @@
+module RbSDL2
+  class RefCountPointer < ::FFI::AutoPointer
+    class << self
+      def entity_class
+        raise NotImplementedError
+      end
+
+      def to_ptr(ptr)
+        raise ArgumentError, 'Invalid pointer, ptr is NULL' if ptr.null?
+        # refcount の増加を AutoPointer 化する前に成功させる必要がある。
+        # AutoPointer になった後に失敗すると、GC に回収されたとき refcount が実際の参照数より少なくなる。
+        entity_class.new(ptr)[:refcount] += 1
+        new(ptr)
+      end
+    end
+
+    # for debug
+    def refcount = self.class.entity_class.new(self)[:refcount]
+  end
+end

data/lib/rb_sdl2/rw_ops/rw_operator.rb

@@ -0,0 +1,102 @@
+module RbSDL2
+  class RWOperator
+    # コールバック関数からの例外は全てコールバック中で拾いエラーを表す戻り値に変える。
+    # SDL がコールバック関数を呼び出すときに与える引数はチェックされていないことを前提とするべきである。
+    # SDL が期待するコールバック関数の戻り値は成功か失敗（エラー）かであり、
+    # read, write などの戻り値を考慮した動作を行わない。
+    # コールバック関数を実装する際には Ruby アプリケーションが困らない設計を行えばよい。
+
+    class CloseCallback < ::FFI::Function
+      def initialize(obj)
+        # int (* close) (struct SDL_RWops * context);
+        super(:int, [:pointer]) do |_context|
+          # close の際に _context ポインターを開放してはならない。
+          (obj.close; 0) rescue -1
+        end
+      end
+    end
+
+    class ReadCallback < ::FFI::Function
+      def initialize(obj)
+        # size_t (* read) (struct SDL_RWops * context, void *ptr, size_t size, size_t maxnum);
+        super(:size_t, [:pointer, :pointer, :size_t, :size_t]) do |_context, ptr, size, max_num|
+          return 0 if ptr.null?
+          max = size * max_num
+          str = obj.read(max)
+          len = str.size
+          # len > max は obj.read が壊れている。
+          return 0 if str.nil? || len > max
+          ptr.write_bytes(str, 0, len)
+          len / size
+        rescue
+          0
+        end
+      end
+    end
+
+    class SeekCallback < ::FFI::Function
+      def initialize(obj)
+        # Sint64 (* seek) (struct SDL_RWops * context, Sint64 offset, int whence);
+        super(:int64, [:pointer, :int64, :int]) do |_context, offset, whence|
+          obj.seek(offset, whence) rescue -1
+        end
+      end
+    end
+
+    class SizeCallback < ::FFI::Function
+      def initialize(obj)
+        # Sint64 (* size) (struct SDL_RWops * context);
+        super(:int64, [:pointer]) do |_context|
+          # 不明な時は -1。Ruby では size が不明確なオブジェクトは size メソッドがないだろう。
+          obj.size rescue -1
+        end
+      end
+    end
+
+    class WriteCallback < ::FFI::Function
+      def initialize(obj)
+        # size_t (* write) (struct SDL_RWops * context, const void *ptr, size_t size, size_t num);
+        super(:size_t, [:pointer, :pointer, :size_t, :size_t]) do |_context, ptr, size, max_num|
+          return 0 if ptr.null?
+          obj.write(ptr.read_bytes(size * max_num)) / size rescue 0
+        end
+      end
+    end
+
+    class RWopsPointer < ::FFI::AutoPointer
+      class << self
+        # SDL_AllocRW で確保したポインターのみ SDL_FreeRW で開放できる。
+        def release(ptr) = ::SDL2.SDL_FreeRW(ptr)
+      end
+    end
+
+    class << self
+      # obj は Ruby IO と同じようにふるまうことを期待している。
+      # obj に対して close, seek, size, read, write のメソッドを呼び出す。
+      # メソッドの呼び出し引数は Ruby IO と同様である。
+      # メソッドの戻り値は Ruby IO と同じ値を返せばよい。
+      # メソッド内での例外は SDL のエラーに変換され、Ruby 側には反映されない。
+      # obj がメソッド呼び出しに応答しない場合も安全である。その場合は SDL 側にエラーが通知される。
+      def new(io)
+        ptr = RWopsPointer.new(::SDL2.SDL_AllocRW)
+        raise RbSDL2Error if ptr.null?
+        super(ptr, io)
+      end
+    end
+
+    def initialize(ptr, obj)
+      st = ::SDL2::SDL_RWops.new(ptr)
+      st[:close] = @close = CloseCallback.new(obj)
+      st[:read]  = @read  = ReadCallback.new(obj)
+      st[:seek]  = @seek  = SeekCallback.new(obj)
+      st[:size]  = @size  = SizeCallback.new(obj)
+      st[:write] = @write = WriteCallback.new(obj)
+      @obj = obj
+      @ptr = ptr
+    end
+
+    def __getobj__ = @obj
+
+    def to_ptr = @ptr
+  end
+end

data/lib/rb_sdl2/rw_ops.rb

@@ -0,0 +1,124 @@
+module RbSDL2
+  class RWOps
+    class Releaser < ::FFI::AutoPointer
+      class << self
+        def release(ptr)
+          # SDL_RWclose は RWOps構造体を開放する。そのため呼び出しは1回しかできない。
+          # ::FFI::AutoPointer を使うことで2重開放を防ぐ。
+          raise RbSDL2Error if ::SDL2.SDL_RWclose(ptr) < 0
+        end
+      end
+
+      def free
+        @released = true
+        super
+      end
+
+      def released? = @released
+    end
+
+    # マルチスレッド対応はしていない。
+    # close メソッドは SDL 側からクローズされていた場合に対応していない。
+    class << self
+      def from_memory(mem, size, autoclose: true, readonly: true)
+        ptr = if readonly
+                ::SDL2.SDL_RWFromConstMem(mem, size)
+              else
+                ::SDL2.SDL_RWFromMem(mem, size)
+              end
+        raise RbSDL2Error if ptr.null?
+        obj = allocate
+        obj.__send__(:initialize, ptr, mem, autoclose: autoclose)
+      end
+
+      # mode は一般的なファイルAPIと同じ文字列が使用できる。
+      def new(file, _mode = "rb", autoclose: true, mode: _mode)
+        ptr = ::SDL2.SDL_RWFromFile(file.to_s, mode)
+        raise RbSDL2Error if ptr.null?
+        obj = super(ptr, autoclose: autoclose)
+        if block_given?
+          begin
+            yield(obj)
+          ensure
+            obj.close
+          end
+        else
+          obj
+        end
+      end
+      alias open new
+
+      def to_ptr(ptr)
+        obj = allocate
+        obj.__send__(:initialize, ptr, autoclose: false)
+        obj
+      end
+
+      require_relative 'rw_ops/rw_operator'
+
+      def with_object(obj)
+        rw = RWOperator.new(obj)
+        obj = allocate
+        obj.__send__(:initialize, rw.to_ptr, rw, autoclose: false)
+      end
+    end
+
+    def initialize(ptr, obj = nil, autoclose:)
+      @obj = obj
+      @ptr = Releaser.new(ptr)
+      self.autoclose = autoclose
+    end
+
+    def autoclose=(bool)
+      @ptr.autorelease = bool
+    end
+
+    def autoclose? = @ptr.autorelease
+
+    def close = @ptr.free
+
+    def closed? = @ptr.released?
+
+    def read(length = nil)
+      raise IOError if closed?
+      len = length.nil? ? size : length.to_i
+      raise ArgumentError if len < 0
+      return "" if len == 0
+      ptr = ::FFI::MemoryPointer.new(len)
+      num = ::SDL2.SDL_RWread(self, ptr, 1, len)
+      raise RbSDL2Error if num == 0
+      ptr.read_bytes(num)
+    end
+
+    def seek(offset, whence = IO::SEEK_SET)
+      raise IOError if closed?
+      raise RbSDL2Error if ::SDL2.SDL_RWseek(self, offset, whence) == -1
+      0
+    end
+
+    def size
+      raise IOError if closed?
+      num = ::SDL2.SDL_RWsize(self)
+      raise RbSDL2Error if num < 0
+      num
+    end
+
+    def to_ptr
+      raise IOError if closed?
+      @ptr
+    end
+
+    def write(*str)
+      raise FrozenError if frozen?
+      raise IOError if closed?
+      str.inject(0) do |sum, obj|
+        bytes = obj.to_s
+        len = bytes.size
+        ptr = ::FFI::MemoryPointer.new(len).write_bytes(bytes)
+        num = ::SDL2.SDL_RWwrite(self, ptr, 1, len)
+        raise RbSDL2Error if num < len
+        sum + len
+      end
+    end
+  end
+end

data/lib/rb_sdl2/screen_saver.rb

@@ -0,0 +1,11 @@
+module RbSDL2
+  module ScreenSaver
+    class << self
+      def enable = ::SDL2.SDL_EnableScreenSaver
+
+      def enabled? = ::SDL2.SDL_IsScreenSaverEnabled == ::SDL2::SDL_TRUE
+
+      def disable = ::SDL2.SDL_DisableScreenSaver
+    end
+  end
+end

data/lib/rb_sdl2/sdl.rb

@@ -0,0 +1,32 @@
+module RbSDL2
+  module SDL
+    module InitFlags
+      class << self
+        def to_num(audio: false, events: false, game_controller: false, haptic: false,
+                   joystick: false, sensor: false, timer: false, video: false)
+          num = 0 |
+            (audio ? ::SDL2::SDL_INIT_TIMER : 0) |
+            (events ? ::SDL2::SDL_INIT_EVENTS : 0) |
+            (game_controller ? ::SDL2::SDL_INIT_GAMECONTROLLER : 0) |
+            (haptic ? ::SDL2::SDL_INIT_HAPTIC : 0) |
+            (joystick ? ::SDL2::SDL_INIT_JOYSTICK : 0) |
+            (sensor ? ::SDL2::SDL_INIT_SENSOR : 0) |
+            (timer ? ::SDL2::SDL_INIT_TIMER : 0) |
+            (video ? ::SDL2::SDL_INIT_VIDEO : 0)
+          num == 0 ? ::SDL2::SDL_INIT_EVERYTHING : num
+        end
+      end
+    end
+
+    class << self
+      def init(**flags)
+        err = ::SDL2.SDL_Init(InitFlags.to_num(**flags))
+        raise RbSDL2Error if err < 0
+      end
+
+      def init?(**flags) = ::SDL2.SDL_WasInit(mask = InitFlags.to_num(**flags)) == mask
+
+      def quit = ::SDL2.SDL_Quit
+    end
+  end
+end

data/lib/rb_sdl2/surface/blend_mode.rb

@@ -0,0 +1,41 @@
+module RbSDL2
+  class Surface
+    module BlendMode
+      class << self
+        def to_num(obj)
+          case obj
+          when /\Aadd/ then ::SDL2::SDL_BLENDMODE_ADD
+          when /\Aalpha/, /\Ablend/ then ::SDL2::SDL_BLENDMODE_BLEND
+          when /\Amod/ then ::SDL2::SDL_BLENDMODE_MOD
+          when /\Amul/ then ::SDL2::SDL_BLENDMODE_MUL
+          when /\Anone/, /\Anormal/ then ::SDL2::SDL_BLENDMODE_NONE
+          else
+            obj.to_i
+          end
+        end
+
+        def to_name(num)
+          case num
+          when ::SDL2::SDL_BLENDMODE_ADD then "additive"
+          when ::SDL2::SDL_BLENDMODE_BLEND then "alpha"
+          when ::SDL2::SDL_BLENDMODE_MOD then "modulate"
+          when ::SDL2::SDL_BLENDMODE_MUL then "multiply"
+          when ::SDL2::SDL_BLENDMODE_NONE then "normal"
+          else
+            ""
+          end
+        end
+      end
+
+      def additive_blend_mode? = ::SDL2::SDL_BLENDMODE_ADD == blend_mode
+
+      def alpha_blend_mode? = ::SDL2::SDL_BLENDMODE_BLEND == blend_mode
+
+      def modulate_blend_mode? = ::SDL2::SDL_BLENDMODE_MOD == blend_mode
+
+      def multiply_blend_mode? = ::SDL2::SDL_BLENDMODE_MUL == blend_mode
+
+      def normal_blend_mode? = ::SDL2::SDL_BLENDMODE_NONE == blend_mode
+    end
+  end
+end