rb_sdl2 0.1.2 → 0.2.0

data/lib/rb_sdl2/rw_ops/rw_ops.rb

@@ -0,0 +1,104 @@
+module RbSDL2
+  require_relative 'rw_file'
+  require_relative 'rw_memory'
+  require_relative 'rw_object'
+
+  class RWOps
+    class << self
+      def open(...)
+        rw = new(...)
+        return rw unless block_given?
+        begin
+          yield(rw)
+        ensure
+          rw.close
+        end
+      end
+
+      alias to_ptr new
+    end
+
+    def initialize(ptr)
+      @ptr = ptr
+    end
+
+    # close 呼び出しの結果によらずポインターは開放されます。
+    # 継承先のクラスは close をオーバーライドしてポインターを適切に扱う必要があります。
+    def close
+      # SDL_RWclose は必ずポインターを開放する。二重開放を防ぐ。
+      unless closed?
+        # クローズ処理は @ptr 先にあるメンバーの close 関数内あるため、SDL_RWclose() を呼ぶ。
+        err = ::SDL.RWclose(@ptr)
+        raise RbSDL2Error if err < 0
+      end
+    rescue => e
+      # Ruby IO と同じように例外を出さない。デバッグモードでは例外を出す。
+      raise e if $DEBUG
+    ensure
+      # ポインターは開放済みのためファイナライザーを停止させる。
+      @ptr.autorelease = false
+      @ptr = nil
+    end
+
+    def closed?
+      # @ptr があるのに autorelease? が false の場合はポインターが Ruby の外に渡されているだろう。
+      # この場合をクローズされたと判断する。
+      !@ptr&.autorelease?
+    end
+
+    def pos=(n)
+      seek(n, IO::SEEK_SET)
+    end
+
+    def read(length = nil)
+      raise IOError if closed?
+      len = length.nil? ? size - tell : length
+      raise ArgumentError if len < 0
+      return "" if len == 0
+      ptr = ::FFI::MemoryPointer.new(len)
+      num = ::SDL.RWread(@ptr, 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 ::SDL.RWseek(@ptr, offset, whence) == -1
+      0
+    end
+
+    def size
+      raise IOError if closed?
+      num = ::SDL.RWsize(@ptr)
+      raise RbSDL2Error if num < 0
+      num
+    end
+
+    def tell
+      raise IOError if closed?
+      num = ::SDL.RWtell(@ptr)
+      raise RbSDL2Error if num == -1
+      num
+    end
+    alias pos tell
+
+    # close メソッドを呼び出した後、インスタンスからポインターを取り出すことはできません。
+    def to_ptr
+      raise TypeError 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 = ::SDL.RWwrite(@ptr, ptr, 1, len)
+        raise RbSDL2Error if num < len
+        sum + len
+      end
+    end
+  end
+end

data/lib/rb_sdl2/rw_ops/rw_ops_pointer.rb

@@ -0,0 +1,14 @@
+module RbSDL2
+  class RWOps
+    class RWOpsPointer < ::FFI::AutoPointer
+      class << self
+        def release(ptr)
+          # SDL_RWclose() は必ず（エラー時も） SDL_RWOps 構造体を開放する。
+          # 2重開放を防ぐため、手動でリソースを開放する場合はこのオブジェクトの free を呼び出すこと。
+          err = ::SDL.RWclose(ptr)
+          raise RbSDL2Error if err < 0
+        end
+      end
+    end
+  end
+end

data/lib/rb_sdl2/sdl.rb

@@ -1,44 +1,83 @@
 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
+    SDL_INIT_TIMER          = 0x00000001
+    SDL_INIT_AUDIO          = 0x00000010
+    SDL_INIT_VIDEO          = 0x00000020
+    SDL_INIT_JOYSTICK       = 0x00000200
+    SDL_INIT_HAPTIC         = 0x00001000
+    SDL_INIT_GAMECONTROLLER = 0x00002000
+    SDL_INIT_EVENTS         = 0x00004000
+    SDL_INIT_SENSOR         = 0x00008000
+
+    SDL_INIT_EVERYTHING = SDL_INIT_TIMER | SDL_INIT_AUDIO | SDL_INIT_VIDEO | SDL_INIT_EVENTS |
+      SDL_INIT_JOYSTICK | SDL_INIT_HAPTIC | SDL_INIT_GAMECONTROLLER | SDL_INIT_SENSOR
 
     class << self
       # SDL を初期化します。
-      # flags に起動したい SDL サブシステムをキーにオプション引数（値は true で起動）で与えます。
-      # flags を指定指定しない場合は全ての SDL コンポーネントが起動します。
-      # オプション引数のキーは audio, events, game_controller, haptic, joystick, sensor, timer, video
-      # があります。
-      def init(**flags)
-        err = ::SDL2.SDL_Init(InitFlags.to_num(**flags))
+      # flags に起動したい SDL サブシステムのシンボルで指定します。
+      # flags を指定指定しない場合は全ての SDL サブシステムが起動します。
+      # SDL サブシステムのシンボルは
+      # :audio, :events, :game_controller, :haptic, :joystick, :sensor, :timer, :video
+      # です。
+      def init(*flags)
+        err = ::SDL.Init(to_num(*flags))
         raise RbSDL2Error if err < 0
       end
 
       # SDL サブシステムが初期化されているか確認します。
-      # アプリケーション作成者が必要とする SDL サブシステム初期化されているか確認できます。
-      # flags に与えたオプションの状態と一致した時のみ true を返します。
-      # 部分的な一致の場合は false を返します。
-      def init?(**flags) = ::SDL2.SDL_WasInit(mask = InitFlags.to_num(**flags)) == mask
+      # flags に与えたシンボルの SDL サブシステムが全て起動している時に true を戻します。
+      def init?(*flags) = ::SDL.WasInit(mask = to_num(*flags)) == mask
 
       # SDL を終了します。RbSDL2 ではアプリケーションの終了時にこのメソッドを呼ぶ必要はありません。
       # 終了後に再び SDL サブシステムを起動する必要がある場合は再度 init メソッドを呼ぶことができます。
       # このメソッドは何度でも呼び出すことができます。
-      def quit = ::SDL2.SDL_Quit
+      def quit = ::SDL.Quit
+
+      private def to_num(*flags)
+        flags.inject(0) { |num, sym|
+          num | case sym
+                when :audio then SDL_INIT_AUDIO
+                when :events then SDL_INIT_EVENTS
+                when :game_controller then SDL_INIT_GAMECONTROLLER
+                when :haptic then SDL_INIT_HAPTIC
+                when :joystick then SDL_INIT_JOYSTICK
+                when :sensor then SDL_INIT_SENSOR
+                when :timer then SDL_INIT_TIMER
+                when :video then SDL_INIT_VIDEO
+                else
+                  raise ArgumentError, "Invalid sub system name(#{sym})"
+                end
+        }.nonzero? || SDL_INIT_EVERYTHING
+      end
+
+      # SDL String(C String, UTF-8) を Ruby String へ変換します。
+      # 戻り値の文字列エンコードは UTF-8 です。ptr へ与えたポインター先のメモリーは開放しません。
+      # ptr へ NULL ポインターを与えても安全です。その場合は空文字を戻します。
+      # 戻り値の文字列は Ruby 側へコピーされたものです。これを変更しても SDL のメモリー領域に影響を与えません。
+      def ptr_to_str(ptr)
+        if ptr.null?
+          ""
+        else
+          ptr.read_string.force_encoding(Encoding::UTF_8)
+        end
+      end
+
+      # 厳密な定義のためエンコーディングは ASCII-8BIT とする。
+      NUL = "\x00".encode!(Encoding::ASCII_8BIT).freeze
+
+      # Ruby String を SDL で取り扱う String へ変換します。
+      # 戻り値は UTF-8 エンコードされた変更不可能な文字列です。
+      # 内部では s へ与えた文字列をコピーし UTF-8 エンコードへ変換します。（元の文字列への影響はありません）
+      # 文字列に NUL 文字が含まれる場合は ArgumentError が発生します。
+      def str_to_sdl(s)
+        # dup -> UTF-8 -> ASCII-8BIT
+        # ASCII-8BIT にするのは size メソッドで正確なバイト数を得るため。（bytesize は忘れることがある）
+        # frozen にして SDL 用文字列を変更（例えばエンコーディング）させない。
+        sdl = String.new(s).encode!(Encoding::UTF_8).force_encoding(Encoding::ASCII_8BIT).freeze
+        # NUL 文字の混入チェック
+        raise ArgumentError if sdl.include?(NUL)
+        sdl
+      end
     end
   end
 end

data/lib/rb_sdl2/sdl_pointer.rb

@@ -0,0 +1,22 @@
+module RbSDL2
+  # SDL のメモリーアロケーターで確保されたメモリー領域を表すクラスです。
+  # SDL 関数の戻り値がポインターで Ruby 側でメモリー開放が必要な時（例えば char ポインター）に使用します。
+  class SDLPointer < ::FFI::AutoPointer
+    class << self
+      def malloc(size)
+        ptr = ::SDL.calloc(1, size)
+        raise NoMemoryError if ptr.null?
+        new(ptr)
+      end
+
+      def from_string(s)
+        sdl = SDL.str_to_sdl(s)
+        malloc(sdl.bytesize + 1).write_string(sdl)
+      end
+
+      def release(ptr) = ::SDL.free(ptr)
+    end
+
+    def to_s = SDL.ptr_to_str(self)
+  end
+end

data/lib/rb_sdl2/surface/blend_mode.rb

@@ -1,41 +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
+module RbSDL2
+  class Surface
+    module BlendMode
+      class << self
+        def to_num(obj)
+          case obj
+          when /\Aadd/ then ::SDL::BLENDMODE_ADD
+          when /\Aalpha/, /\Ablend/ then ::SDL::BLENDMODE_BLEND
+          when /\Amod/ then ::SDL::BLENDMODE_MOD
+          when /\Amul/ then ::SDL::BLENDMODE_MUL
+          when /\Anone/, /\Anormal/ then ::SDL::BLENDMODE_NONE
+          else
+            obj.to_i
+          end
+        end
+
+        def to_name(num)
+          case num
+          when ::SDL::BLENDMODE_ADD then "additive"
+          when ::SDL::BLENDMODE_BLEND then "alpha"
+          when ::SDL::BLENDMODE_MOD then "modulate"
+          when ::SDL::BLENDMODE_MUL then "multiply"
+          when ::SDL::BLENDMODE_NONE then "normal"
+          else
+            ""
+          end
+        end
+      end
+
+      def additive_blend_mode? = ::SDL::BLENDMODE_ADD == blend_mode
+
+      def alpha_blend_mode? = ::SDL::BLENDMODE_BLEND == blend_mode
+
+      def modulate_blend_mode? = ::SDL::BLENDMODE_MOD == blend_mode
+
+      def multiply_blend_mode? = ::SDL::BLENDMODE_MUL == blend_mode
+
+      def normal_blend_mode? = ::SDL::BLENDMODE_NONE == blend_mode
+    end
+  end
+end

data/lib/rb_sdl2/surface/pixel_format.rb

@@ -5,37 +5,34 @@ module RbSDL2
 
       class PixelFormatPointer < RefCountPointer
         class << self
-          def release(ptr) = ::SDL2.SDL_FreeFormat(ptr)
+          def release(ptr) = ::SDL.FreeFormat(ptr)
 
-          def entity_class = ::SDL2::SDL_PixelFormat
+          def entity_class = ::SDL::PixelFormat
         end
       end
 
       class << self
-        require_relative '../pixel_format_enum'
-
-        def new(format)
-          ptr = PixelFormatPointer.new(::SDL2::SDL_AllocFormat(PixelFormatEnum.to_num(format)))
-          raise RbSDL2Error if ptr.null?
-          super(ptr)
-        end
-
-        def to_ptr(ptr)
-          obj = allocate
-          obj.__send__(:initialize, PixelFormatPointer.to_ptr(ptr))
-          obj
-        end
+        # アプリケーションが PixelFormat を作成する必要がないためコンストラクターを実装しない。
+        # FFI::AutoPointer によるポインター管理を行っているのは Surface 側で PixelFormat を公開しているため。
       end
 
       def initialize(ptr)
-        @st = ::SDL2::SDL_PixelFormat.new(ptr)
+        @st = ::SDL::PixelFormat.new(PixelFormatPointer.to_ptr(ptr))
       end
 
       def ==(other)
-        other.respond_to?(:to_ptr) && to_ptr == other.to_ptr
+        other.respond_to?(:to_ptr) && other.to_ptr == to_ptr
       end
 
-      def alpha_mask? = @st[:Amask] > 0
+      def a_mask = @st[:Amask]
+
+      def b_mask = @st[:Bmask]
+
+      def g_mask = @st[:Gmask]
+
+      def r_mask = @st[:Rmask]
+
+      def a_mask? = @st[:Amask] > 0
 
       def bits_per_pixel = @st[:BitsPerPixel]
       alias bpp bits_per_pixel
@@ -50,37 +47,41 @@ module RbSDL2
       # indexed format のときはパレット番号を戻す。
       def pack_color(color)
         r, g, b, a = color
-        if alpha_mask?
-          ::SDL2.SDL_MapRGBA(self, r, g, b, a || ::SDL2::SDL_ALPHA_OPAQUE)
+        if a_mask?
+          ::SDL.MapRGBA(self, r, g, b, a || ::SDL::ALPHA_OPAQUE)
         else
-          ::SDL2.SDL_MapRGB(self, r, g, b)
+          ::SDL.MapRGB(self, r, g, b)
         end
       end
 
       require_relative '../palette'
 
+      # パレットがある場合は Palette インスタンスを戻します。ない場合は nil を戻します。
       def palette
-        # パレットは参照カウンターで生存の保証がある。
-        # Ruby 側がパレットを保持している限り同一アドレスに違うパレットが作成されることはない。
-        # SDL では PixelFormat の palette メンバーは（行儀よく SDL_SetPixelFormatPalette を使う場合は）
-        # 後から NULL に書き換わることはない。
-        (ptr = @st[:palette]) == @palette&.to_ptr ? @palette : @palette = Palette.to_ptr(ptr)
+        Palette.to_ptr(@st[:palette]) unless @st[:palette].null?
       end
 
       def palette=(pal)
-        err = ::SDL2.SDL_SetPixelFormatPalette(self, pal)
-        raise RbSDL2Error if err < 0
-        @palette = nil
+        # SDL_SetPixelFormatPalette() はパレット・ポインターが NULL かどうかチェックしていない。
+        if Palette === pal && !pal.to_ptr.null?
+          err = ::SDL.SetPixelFormatPalette(self, pal)
+          raise RbSDL2Error if err < 0
+        else
+          raise ArgumentError, "pointer is NULL"
+        end
       end
 
+      def palette? = !@st[:palette].null?
+
       def to_ptr = @st.to_ptr
 
       # indexed format のときはパレット番号を引数へ与える。
-      def unpack_color(pixel)
-        if alpha_mask?
-          ::SDL2.SDL_GetRGBA(pixel, self, *Array.new(4) { ::FFI::MemoryPointer.new(:uint8) })
+      def unpack_pixel(num)
+        color = Array.new(a_mask? ? 4 : 3) { ::FFI::MemoryPointer.new(:uint8) }
+        if a_mask?
+          ::SDL.GetRGBA(num, self, *color)
         else
-          ::SDL2.SDL_GetRGB(pixel, self, *Array.new(3) { ::FFI::MemoryPointer.new(:uint8) })
+          ::SDL.GetRGB(num, self, *color)
         end
         color.map(&:read_uint8)
       end