rb_sdl2 0.1.0 → 0.2.0

data/lib/rb_sdl2/cursor.rb

@@ -1,39 +1,120 @@
 module RbSDL2
-  module Cursor
-    # カーソルポインターが外部から設定される場合があるため、現在のカーソルを取得する方法を提供しない。
-    class << self
-      require_relative 'cursor/color_cursor'
-      def color_cursor(...) = ColorCursor.new(...)
+  class Cursor
+    class CursorPointer < ::FFI::AutoPointer
+      class << self
+        # カーソルポインターはいつでも（表示中であっても）安全に開放できる。
+        # SDL はカレントカーソルが開放されたときはデフォルトカーソルをカレントカーソルに設定する。
+        # デフォルトカーソルは FreeCursorを呼び出しても開放されない。
+        def release(ptr) = ::SDL.FreeCursor(ptr)
+      end
+    end
 
+    @current = nil # カレントカーソルのオブジェクトを GC に回収されないように保持するために使用。
+
+    class << self
+      # nil を与えた場合デフォルトカーソルが設定されます。
       def current=(cursor)
-        ::SDL2.SDL_SetCursor(cursor)
+        @current = if cursor.nil?
+                     ::SDL.SetCursor(::SDL.GetDefaultCursor) # => nil
+                   elsif Cursor === cursor
+                     ::SDL.SetCursor(cursor)
+                     cursor
+                   else
+                     raise TypeError
+                   end
       end
 
-      def current?(cursor)
-        ::SDL2.SDL_GetCursor == cursor.to_ptr
-      end
+      def current?(cursor) = ::SDL.GetCursor == cursor.to_ptr
 
-      require_relative 'cursor/default_cursor'
-      def default_cursor = DefaultCursor.instance
+      def hide
+        ::SDL.ShowCursor(::SDL::DISABLE)
+        nil
+      end
 
-      def hide = ::SDL2.SDL_ShowCursor(::SDL2::SDL_DISABLE)
+      def show
+        ::SDL.ShowCursor(::SDL::ENABLE)
+        nil
+      end
 
-      def show = ::SDL2.SDL_ShowCursor(::SDL2::SDL_ENABLE)
+      def shown? = ::SDL.ShowCursor(::SDL::QUERY) == ::SDL::ENABLE
 
-      def shown? = ::SDL2.SDL_ShowCursor(::SDL2::SDL_QUERY) == ::SDL2::SDL_ENABLE
+      # カーソルの再描画を行います。
+      def update = ::SDL.SetCursor(nil); self
 
-      def update
-        self.current = nil
-        self
+      # obj が Surface オブジェクトの時はカラーカーソルを作成します。
+      # その際に hot 引数にカーソルの判定位置を与えることができます。値は [x, y] です。
+      # 引数に与えた Surface オブジェクトは SDL 側にコピーされるため呼び出し後に安全に開放できます。
+      # obj が Symbol の時はシステムカーソルを作成します。
+      # Symbol は :arrow, :i_beam, :wait, :crosshair, :wait_arrow, :size_nw_se, :size_ne_sw,
+      # :size_we, :sie_ns, :size_all, :no, :hand が指定できます。
+      # obj が　nil の場合はデフォルトカーソルを作成します。
+      def new(obj = nil, hot: nil)
+        ptr = CursorPointer.new(
+          case obj
+          when Surface
+            hot_x, hot_y = hot
+            # SDL_CreateColorCursor() は与えられた surface をコピーする。
+            # 呼び出し後に引数に与えた surface オブジェクトは安全に開放できる。
+            ::SDL.CreateColorCursor(obj, hot_x, hot_y)
+          when Symbol
+            id = case obj
+                 when :arrow      then ::SDL::SYSTEM_CURSOR_ARROW
+                 when :i_beam     then ::SDL::SYSTEM_CURSOR_IBEAM
+                 when :wait       then ::SDL::SYSTEM_CURSOR_WAIT
+                 when :crosshair  then ::SDL::SYSTEM_CURSOR_CROSSHAIR
+                 when :wait_arrow then ::SDL::SYSTEM_CURSOR_WAITARROW
+                 when :size_nw_se then ::SDL::SYSTEM_CURSOR_SIZENWSE
+                 when :size_ne_sw then ::SDL::SYSTEM_CURSOR_SIZENESW
+                 when :size_we    then ::SDL::SYSTEM_CURSOR_SIZEWE
+                 when :size_ns    then ::SDL::SYSTEM_CURSOR_SIZENS
+                 when :size_all   then ::SDL::SYSTEM_CURSOR_SIZEALL
+                 when :no         then ::SDL::SYSTEM_CURSOR_NO
+                 when :hand       then ::SDL::SYSTEM_CURSOR_HAND
+                 else raise ArgumentError
+                 end
+            ::SDL.CreateSystemCursor(id)
+          when nil
+            # SDL 側にあるデフォルトカーソルのポインターを戻す。このポインターはシングルトンである。
+            # ポインターを SDL_FreeCursor() へ与えても安全である。SDL 内部では開放されない。
+            ::SDL.GetDefaultCursor
+          else
+            raise ArgumentError
+          end
+        )
+        raise RbSDL2Error if ptr.null?
+        super(ptr)
       end
     end
 
-    require 'forwardable'
-    extend SingleForwardable
-    require_relative 'cursor/system_cursor'
-    def_single_delegators :SystemCursor,
-                          *%i(arrow_cursor crosshair_cursor hand_cursor i_beam_cursor no_cursor
-                          size_all_cursor size_ne_sw_cursor size_ns_cursor size_nw_se_cursor
-                          size_we_cursor wait_cursor wait_arrow_cursor)
+    def initialize(ptr)
+      @ptr = ptr
+    end
+
+    def ==(other)
+      other.respond_to?(:to_ptr) && other.to_ptr == @ptr
+    end
+
+    # 自身をカレントカーソルに設定します。カーソルの表示状態は変更されません。
+    def current! = Cursor.current = self
+
+    # 自身がカレントカーソルの場合に true を戻します。
+    def current? = Cursor.current?(self)
+
+    # 自身がカレントカーソルの場合のみカーソルを非表示にします。
+    def hide
+      current? && Cursor.hide
+      self
+    end
+
+    # 自身を表示カーソルにします。この時カレントカーソルは自身に設定されています。
+    def show
+      current! && Cursor.show
+      self
+    end
+
+    # 自身がカレントカーソルの場合かつカーソル表示中の時に true を戻します。
+    def shown? = current? && Cursor.shown?
+
+    def to_ptr = @ptr
   end
 end

data/lib/rb_sdl2/display.rb

@@ -2,7 +2,7 @@ module RbSDL2
   class Display
     class << self
       def displays
-        count = ::SDL2.SDL_GetNumVideoDisplays
+        count = ::SDL.GetNumVideoDisplays
         raise RbSDL2Error if count < 0
         count.times.map { |num| Display.new(num) }
       end
@@ -14,7 +14,7 @@ module RbSDL2
 
     def bounds
       rect = Rect.new
-      err = ::SDL2.SDL_GetDisplayBounds(index, rect)
+      err = ::SDL.GetDisplayBounds(index, rect)
       raise RbSDL2Error if err < 0
       rect.to_a
     end
@@ -24,7 +24,7 @@ module RbSDL2
     def closest_display_mode(**display_mode)
       mode ||= DisplayMode.new(**display_mode)
       closest = DisplayMode.new
-      err = ::SDL2.SDL_GetClosestDisplayMode(self, mode, closest)
+      err = ::SDL.GetClosestDisplayMode(self, mode, closest)
       raise RbSDL2Error if err.null?
       closest
       # 利用可能なディスプレイモードが検索され, 要求と最も近いモードがclosestに代入される.
@@ -35,24 +35,24 @@ module RbSDL2
 
     def current_display_mode
       obj = DisplayMode.new
-      err = ::SDL2.SDL_GetCurrentDisplayMode(index, obj)
+      err = ::SDL.GetCurrentDisplayMode(index, obj)
       raise RbSDL2Error if err < 0
       obj
     end
 
     def desktop_display_mode
       obj = DisplayMode.new
-      err = ::SDL2.SDL_GetDesktopDisplayMode(index, obj)
+      err = ::SDL.GetDesktopDisplayMode(index, obj)
       raise RbSDL2Error if err < 0
       obj
     end
 
     def display_modes
-      num = ::SDL2.SDL_GetNumDisplayModes(index)
+      num = ::SDL.GetNumDisplayModes(index)
       raise RbSDL2Error if num < 0
       num.times.map do |mode_index|
         obj = DisplayMode.new
-        err = ::SDL2.SDL_GetDisplayMode(index, mode_index, obj)
+        err = ::SDL.GetDisplayMode(index, mode_index, obj)
         raise RbSDL2Error if err < 0
         obj
       end
@@ -61,7 +61,7 @@ module RbSDL2
     # ディスプレイピクセルの斜め、水平、垂直方向の DPI を配列で戻す。
     def dpi
       d_h_v_dpi = Array.new(3) { ::FFI::MemoryPointer.new(:float) }
-      err = ::SDL2.SDL_GetDisplayDPI(index, *d_h_v_dpi)
+      err = ::SDL.GetDisplayDPI(index, *d_h_v_dpi)
       raise RbSDL2Error if err < 0
       d_h_v_dpi.map { |v| v.read_float }
     end
@@ -74,28 +74,28 @@ module RbSDL2
     end
 
     def name
-      ptr = ::SDL2.SDL_GetDisplayName(index)
+      ptr = ::SDL.GetDisplayName(index)
       raise RbSDL2Error if ptr.null?
-      ptr.read_string.force_encoding(Encoding::UTF_8)
+      SDL.ptr_to_str(ptr)
     end
     alias to_s name
 
-    def orientation = ::SDL2.SDL_GetDisplayOrientation(index)
+    def orientation = ::SDL.GetDisplayOrientation(index)
 
     module DisplayOrientation
-      def flipped_landscape? = ::SDL2::SDL_ORIENTATION_LANDSCAPE_FLIPPED == orientation
+      def flipped_landscape? = ::SDL::ORIENTATION_LANDSCAPE_FLIPPED == orientation
 
-      def flipped_portrait? = ::SDL2::SDL_ORIENTATION_PORTRAIT_FLIPPED == orientation
+      def flipped_portrait? = ::SDL::ORIENTATION_PORTRAIT_FLIPPED == orientation
 
-      def landscape? = ::SDL2::SDL_ORIENTATION_LANDSCAPE == orientation
+      def landscape? = ::SDL::ORIENTATION_LANDSCAPE == orientation
 
-      def portrait? = ::SDL2::SDL_ORIENTATION_PORTRAIT == orientation
+      def portrait? = ::SDL::ORIENTATION_PORTRAIT == orientation
     end
     include DisplayOrientation
 
     def usable_bounds
       rect = Rect.new
-      err = ::SDL2.SDL_GetDisplayUsableBounds(index, rect)
+      err = ::SDL.GetDisplayUsableBounds(index, rect)
       raise RbSDL2Error if err < 0
       rect.to_a
     end

data/lib/rb_sdl2/display_mode.rb

@@ -1,7 +1,7 @@
 module RbSDL2
   class DisplayMode
     def initialize(format: 0, h: 0, height: h, refresh_rate: 0, w: 0, width: w)
-      @st = ::SDL2::SDL_DisplayMode.new
+      @st = ::SDL::DisplayMode.new
       @st[:format] = PixelFormatEnum.to_num(format)
       @st[:w] = width
       @st[:h] = height

data/lib/rb_sdl2/error.rb

@@ -1,9 +1,20 @@
 module RbSDL2
-  module Error
+  class Error < StandardError
     class << self
-      def clear = ::SDL2.SDL_ClearError
+      # SDL が設定したエラーメッセージをクリアします。
+      def clear = ::SDL.ClearError
 
-      def message = ::SDL2.SDL_GetError.read_string
+      # SDL からのエラーメッセージを文字列で返します。
+      # SDL からエラーが通知されてもエラーメッセージがあるとは限りません。
+      # SDL の関数はエラーの状態を示してもエラーメッセージをセットしない場合があります。
+      def last_error_message = SDL.ptr_to_str(::SDL.GetError)
+
+      def last_error_message=(error_message)
+        # SDL_SetError() の第一引数は sprintf フォーマットである。
+        # このメソッドのデザインの都合上、可変長引数を与える方法が無い。
+        # "%" をエスケープすることで第二引数を無視させてメモリー参照を行わないようにする。
+        ::SDL.SetError(SDL.str_to_sdl(error_message.gsub(/%/, "%%")))
+      end
     end
   end
 end

data/lib/rb_sdl2/errors.rb

@@ -0,0 +1,7 @@
+module RbSDL2
+  class RbSDL2Error < StandardError
+    def initialize(error_message = nil)
+      super(error_message || Error.last_error_message)
+    end
+  end
+end

data/lib/rb_sdl2/event/event.rb

@@ -0,0 +1,130 @@
+module RbSDL2
+  class Event
+    # SDL_SYSWMEVENT の msg メンバーの実装はしない。
+    # msg ポインターが指す SDL_SysWMmsg は構造体サイズが環境に依存するためコピーを行うことができない。
+    # SDL_SYSWMEVENT イベントの作成はできない、受け取りはできるが msg メンバーへのアクセスはできない。
+    # SDL は SDL_SYSWMEVENT にある SDL_SysWMmsg をマネージしている。
+    # イベントへの追加ではコピーを行い、取り出しの際にはテンポラリ領域へコピーしてからアプリケーションへ渡す。
+    # アプリケーションが SDL_SYSWMEVENT を無視してもメモリーリークはしない。
+
+    require 'forwardable'
+    extend SingleForwardable
+
+    require_relative 'event_filter'
+    def_single_delegators EventFilter, *%i(define_watch filter_callback_defined? undefine_watch)
+
+    require_relative 'event_queue'
+    def_single_delegators EventQueue, *%i(clear exist? poll pump wait)
+
+    class << self
+      def quit?
+        pump
+        exist?(::SDL::QUIT)
+      end
+    end
+
+    require_relative 'event_type'
+    def_single_delegators EventType, *%i(disable enable ignore? register_events)
+
+    include EventType
+
+    require_relative 'event_pointer'
+
+    class << self
+      def new(type:, **members)
+        obj = super(EventPointer.new(type))
+        members.each_pair { |sym, val| obj[sym] = val }
+        obj
+      end
+
+      def to_ptr(ptr)
+        obj = allocate
+        obj.__send__(:initialize, ptr)
+        obj
+      end
+    end
+
+    def initialize(ptr)
+      @ptr = ptr
+      @entity = nil
+      @obj = if drop_file? || drop_text?
+               SDLPointer.new(entity[:file])
+             elsif text_editing_ext?
+               SDLPointer.new(entity[:text])
+             elsif sys_wm_event? && entity[:msg].null?
+               # msg に NULL があると SDL はこのポインターをチェックせずに読み出す。
+               raise TypeError
+             end
+    end
+
+    # SDL_SYSWMEVENT の msg はポインターです。このポインターの取り扱いはアプリケーションに委ねられます。
+    # SDL_USEREVENT の data1, data2 はポインターです。このポインターの取り扱いはアプリケーションに委ねられます。
+    def [](sym)
+      obj = entity[sym]
+      case sym
+      when :data   then obj.to_a
+      when :file   then if drop_file? || drop_text?
+                          SDL.ptr_to_str(obj)
+                        else
+                          # SDL_EVENTBEGIN, SDL_DROPCOMPLETE はこのメンバー使用しない。
+                          nil
+                        end
+      when :keysym then { scancode: obj[:scancode], sym: obj[:sym], mod: obj[:mod] }
+      when :msg    then obj
+      when :text   then SDL.ptr_to_str(obj.to_ptr)
+      when :type   then type
+      else obj
+      end
+    end
+
+    # SDL_SYSWMEVENT の msg への書き込みはできません。
+    # SDL_USEREVENT の data1, data2 はポインターです。このポインターの取り扱いはアプリケーションに委ねられます。
+    def []=(sym, val)
+      raise FrozenError if frozen?
+
+      case sym
+      when :data   then entity[sym].tap { |st| val.each.with_index { |v, i| st[i] = v } }
+      when :file   then if drop_file? || drop_text?
+                          entity[sym] = @obj = SDLPointer.from_string(val)
+                        else
+                          # SDL_EVENTBEGIN, SDL_DROPCOMPLETE はこのメンバー使用しない。
+                          raise TypeError
+                        end
+      when :keysym then entity[sym].tap { |st| val.each { |k, v| st[k] = v } }
+      when :msg    then raise NotImplementedError
+      when :text   then if text_editing_ext?
+                          entity[sym] = @obj = SDLPointer.from_string(val)
+                        else
+                          ::SDL.utf8strlcpy(entity[sym].to_ptr, SDL.str_to_sdl(val), entity[sym].size)
+                        end
+      when :type   then raise TypeError
+      else entity[sym] = val
+      end
+    end
+
+    private def entity = @entity ||= EventType::ENTITY_MAP[type].new(@ptr)
+
+    # clone, dup はディープコピーを行います。
+    def initialize_copy(obj)
+      super
+      initialize(EventPointer.copy(obj.to_ptr))
+    end
+
+    def inspect = "#<#{self.class.name}: #{name}>"
+
+    def member?(name) = members.include?(name)
+
+    def members = entity.members.grep_v(/\Apadding/)
+
+    def name = EventType.to_name(type)
+
+    def to_h = members.map { |sym| [sym, self[sym]] }.to_h
+
+    def to_ptr = @ptr
+
+    def to_s = name.to_s
+
+    def type = @ptr.type
+    alias to_i type
+  end
+end

data/lib/rb_sdl2/event/event_filter.rb

@@ -1,82 +1,46 @@
 module RbSDL2
-  class Event
-    class EventFilter < ::FFI::Function
-      @filter_callback = nil, nil
-      @filter_mutex = Mutex.new
+  class EventFilter < ::FFI::Function
 
-      class << self
-        def filter_callback_set(obj, userdata = nil)
-          func = if Proc === obj
-                   # イベントを削除する時にイベントメンバーのポインターを開放（Event#clear）する。
-                   new { |event| obj.call(event) || (event.clear; nil) }
-                 else
-                   obj
-                 end
-          # func, userdata の対の関係を保つ。
-          @filter_mutex.synchronize do
-            ::SDL2.SDL_SetEventFilter(func, userdata)
-            @filter_callback = [func, userdata]
-          end
-          [obj, userdata]
-        end
+    class Releaser
+      def initialize(obj) = @obj = obj
 
-        # SDL にフィルターコールバック関数が設定されている場合に true を戻す。
-        def filter_callback_defined?
-          _func_userdata = Array.new(2) { ::FFI::MemoryPointer.new(:pointer) }
-          # SDL_GetEventFilter はコールバックのポインター関数が NULL の場合に SDL_FALSE となる。
-          # userdata ポインターが設定されていても SDL_GetEventFilter の戻り値に関与しない。
-          ::SDL2.SDL_GetEventFilter(*_func_userdata) == ::SDL2::SDL_TRUE
-        end
-      end
+      def call(_id) = ::SDL.DelEventWatch(@obj, nil)
+    end
+
+    @watches = []
 
-      @watch_callbacks = []
-      @watch_mutex = Mutex.new
+    class << self
+      def define_watch(func)
+        ::SDL.AddEventWatch(func, nil)
+        @watches << func.__id__
+        ptr = ::FFI::Pointer.new(func.address)
+        ObjectSpace.define_finalizer(func, Releaser.new(ptr))
+      end
 
-      class << self
-        def add_watch_callback(obj, userdata = nil)
-          func = if Proc === obj
-                   new(&obj)
-                 else
-                   obj
-                 end
-          obj_userdata = [obj, userdata]
-          @watch_mutex.synchronize do
-            ::SDL2.SDL_AddEventWatch(func, userdata)
-            @watch_callbacks << [obj_userdata, func]
-          end
-          obj_userdata
-        end
+      def undefine_watch(func)
+        func_id = func.__id__
+        @watches.delete_if { |id| (id == func_id).tap { ::SDL.DelEventWatch(func, nil) } }
+        ObjectSpace.undefine_finalizer(func)
+      end
 
-        def remove_watch_callback(obj, userdata = nil)
-          obj_userdata = [obj, userdata]
-          @watch_mutex.synchronize do
-            idx = @watch_callbacks.index { |obj| obj.first == obj_userdata }
-            if idx
-              _, func = @watch_callbacks.delete_at(idx)
-              ::SDL2.SDL_DelEventWatch(func, userdata)
-            end
-          end
-          obj_userdata
-        end
+      # SDL にフィルターコールバック関数が設定されている場合に true を戻す。
+      def filter_callback_defined?
+        ::SDL.GetEventFilter(nil, nil) == ::SDL::TRUE
       end
+    end
 
-      require 'delegate'
+    require_relative 'event'
+    require_relative 'event_pointer'
 
-      # 引数ブロックへはコールバック実行時に Event のインスタンス（のデリゲーター）が与えられる。
-      # 与えられた Event インスタンスは引数ブロック終了後に nil に変化する(デリゲート先を変更している)。
-      # SDL がイベントコールバックへ与えるイベントへのポインターがイベントキューの一部を直接指しているため
-      # コールバックを抜けた後にイベント内容の永続性が保証ができない（たぶん別のイベント内容になるだろう）。
-      # 引数ブロックに与えられたオブジェクトをスコープ外に持ち出しても安全である。
-      # オブジェクトではなくイベントの内容をスコープ外に持ち出したい場合は
-      # 与えられたオブジェクトをコピー（clone, dup）すればよい。
-      def initialize
-        # typedef int (SDLCALL * SDL_EventFilter) (void *userdata, SDL_Event * event);
-        super(:int, [:pointer, :pointer]) do |_userdata, ptr|
-          obj = SimpleDelegator.new(Event.to_ptr(ptr))
-          yield(obj) ? 1 : 0
-        ensure
-          obj.__setobj__(nil)
-        end
+    # コールバックにはコピーしたイベントが与えられます。
+    # よって SDL のイベントキューにあるイベントを書き換えることはできません。
+    def initialize(proc)
+      # int EventFilter(void* userdata, SDL_Event* event);
+      super(:int, [:pointer, :pointer]) do |_userdata, ptr|
+        # SDL のイベントキューへの参照ポインターを受け取る場合は必ずコピーを取る必要がある。
+        # キューの状態は変化するため、次にアクセスする際にポインター先が存在する保証はない。
+        # SDL のイベントキューを参照している間は SDL がキューをロックしているためコピーは安全にできる。
+        proc.call( Event.to_ptr(EventPointer.copy(ptr)) ) ? 1 : 0
       end
     end
   end

data/lib/rb_sdl2/event/event_pointer.rb

@@ -0,0 +1,26 @@
+module RbSDL2
+  class EventPointer < ::FFI::MemoryPointer
+    class << self
+      def copy(ptr)
+        obj = malloc
+        ::SDL.memcpy(obj, ptr, size)
+        type = obj.type
+        if ::SDL::DROPFILE == type || ::SDL::DROPTEXT == type
+          ref = obj + ::SDL::DropEvent.offset_of(:file)
+          str = ::SDL.strdup(ref.read_pointer)
+          raise NoMemoryError if str.null?
+          ref.write_pointer(str)
+        end
+        obj
+      end
+
+      def malloc = new(0)
+
+      def new(type) = super(size).write_uint32(type)
+
+      def size = ::SDL::Event.size
+    end
+
+    def type = read_uint32
+  end
+end