rb_sdl2 0.1.0

data/lib/rb_sdl2/event.rb

@@ -0,0 +1,161 @@
+module RbSDL2
+  class Event
+    class EventPointer < ::FFI::AutoPointer
+      class << self
+        def malloc
+          ptr = new(::SDL2.SDL_calloc(1, ::SDL2::SDL_Event.size))
+          raise NoMemoryError if ptr.null?
+          ptr
+        end
+
+        def release(ptr)
+          # メンバーのポインターを開放する。
+          Event.to_ptr(ptr).clear
+          ::SDL2.SDL_free(ptr)
+        end
+      end
+    end
+
+    require 'forwardable'
+    extend SingleForwardable
+
+    require_relative 'event/event_filter'
+    def_single_delegators "Event::EventFilter",
+                          *%i(add_watch_callback filter_callback_set filter_callback_defined?
+                          remove_watch_callback)
+
+    require_relative 'event/event_queue'
+    def_single_delegators "Event::EventQueue",
+                          *%i(clear count deq each empty? enq get length peep poll pump push push!
+                          quit? size reject! wait)
+
+    require_relative 'event/event_type'
+    def_single_delegators "Event::EventQueue", *%i(define_user_event disable enable ignore?)
+
+    class << self
+      def new(type: 0, **members)
+        ptr = EventPointer.malloc
+        num = Numeric === type ? type : EventType.to_num(type)
+        ptr.write_uint32(num)
+        obj = super(ptr)
+        if obj.typed?
+          members.each_pair { |sym, val| obj[sym] = val }
+        end
+        obj
+      end
+
+      def to_ptr(ptr)
+        obj = allocate
+        obj.__send__(:initialize, ptr)
+        obj
+      end
+    end
+
+    # UserEvent の data1, data2 メンバー、SysWMEvent の msg メンバーはポインターである。
+    # ポインターとしての読み書きの対応はしている。しかしポインターが指し示すメモリーの管理は行わない。
+    def initialize(ptr)
+      @ptr = ptr
+    end
+
+    def [](sym)
+      raise ArgumentError unless member?(sym)
+
+      case sym
+      when :data
+        member[:data].to_a
+      when :file
+        member[:file].then { |ptr| ptr.null? ? nil : ptr.read_string }
+      when :keysym
+        member[:keysym].then { |st| {scancode: st[:scancode], sym: st[:sym], mod: st[:mod]} }
+      when :text
+        member[:text].to_s
+      else
+        member[sym]
+      end
+    end
+
+    # DropEvent の file メンバーのポインターの管理は行われる。
+    # UserEvent の data1, data2 メンバーと SysWMEvent の msg メンバーはポインターである。
+    # これらのポインターの管理は行ない。アプリケーション側で実装を行うこと。
+    def []=(sym, val)
+      raise FrozenError if frozen?
+      raise ArgumentError unless member?(sym)
+
+      case sym
+      when :data
+        val.each.with_index { |v, i| member[:data][i] = v }
+      when :file
+        if drop_file? || drop_text?
+          _ptr = member[:file]
+
+          member[:file] = if val.nil?
+                            nil
+                          else
+                            c_str = "#{val}\x00"
+                            ptr = ::SDL2.SDL_malloc(c_str.size)
+                            raise NoMemoryError if ptr.null?
+                            ptr.write_bytes(c_str)
+                          end
+
+          ::SDL2.SDL_free(_ptr)
+        else
+          raise ArgumentError
+        end
+      when :keysym
+        val.each { |k, v| member[:keysym][k] = v }
+      when :msg
+        if val.nil? || val.respond_to?(:null?) && val.null? || val.respond_to?(:zero?) && val.zero?
+          raise ArgumentError
+        end
+        member[:msg] = val
+      when :type
+        raise ArgumentError
+      else
+        member[sym] = val
+      end
+    end
+
+    def clear
+      raise FrozenError if frozen?
+      if drop_file? || drop_text?
+        self[:file] = nil
+      end
+      member.clear
+      @st = nil
+      self
+    end
+
+    # deep copy を行う。
+    # これは @ptr が イベントキューの一部（SDL の管理領域）を指している場合があるためである。
+    def initialize_copy(obj)
+      super
+      @ptr = EventPointer.malloc.write_bytes(obj.to_ptr.read_bytes(::SDL2::SDL_Event.size))
+      if drop_file? || drop_text?
+        self[:file] = obj[:file]
+      end
+    end
+
+    def inspect
+      "#<#{self.class.name} ptr=#{@ptr.inspect} name=#{name.inspect} #{to_h}>"
+    end
+
+    protected def member = @st ||= ::SDL2::SDL_Event.new(@ptr)[EventType.to_type(type)]
+
+    def member?(name) = members.include?(name)
+
+    def members = member.members.grep_v(/\Apadding/)
+
+    def name = EventType.to_name(type)
+    alias to_s name
+
+    def to_h = members.map { |sym| [sym, self[sym]] }.to_h
+
+    def to_ptr = @ptr
+
+    def type = to_ptr.read_uint32
+
+    include EventType
+
+    def typed? = type != 0
+  end
+end

data/lib/rb_sdl2/filesystem.rb

@@ -0,0 +1,40 @@
+module RbSDL2
+  module Filesystem
+    class << self
+      # RbSDL2 にロードされた SDL2 の配置パスを戻す。
+      # パスの末尾にはパスの区切り文字がかならずある。
+      # パスの区切り記号は環境依存である。Windows であれば "\" が使われる。
+      # Ruby は環境依存のパスの区切り文字を正しく取り扱うことができる。
+      def base_path
+        ptr = ::SDL2.SDL_GetBasePath
+        raise RbSDL2Error if ptr.null?
+        ptr.read_string.force_encoding(Encoding::UTF_8)
+      ensure
+        ::SDL2.SDL_free(ptr)
+      end
+
+      # アプリケーションが書き込むことのできるパスを戻す。
+      # このパスはユーザ毎に存在し、かつアプリケーション固有のものであり OS によって保証されている。
+      # org_name, app_name 引数はパスの生成に利用される。引数にパスの区切り記号がある場合はそれを取り除く。
+      # ここに SDL2 が提示した守るべきルールの要約を記す。
+      # - アプリケーション内でこのメソッドw呼び出す際は org_name は常に同じ文字列を使うこと。
+      # - アプリケーションごとに違う app_name を使うこと.
+      # - アプリケーションに一度割り当てた app_name は変更しないこと。
+      # - 使用する文字はアルファベット, 数字, 空白のみにすること.
+      #
+      # 注意: このメソッドを呼ぶと SDL はこのメソッドが戻すパスを実際に作成する。
+      # 書き込みを行わなかった場合、空のフォルダーが残る。
+      # 引数に空文字を渡しすことも、また既存のフォルダーになるように引数を与えることもできる。
+      # SDL が知りたいことはアプリケーションがアクセス可能かどうかだけだ。
+      # エラーが出るかどうかはユーザが設定するパスのアクセス制限による。
+      def pref_path(org_name, app_name)
+        ptr = ::SDL2.SDL_GetPrefPath(org_name.encode(Encoding::UTF_8),
+                                     app_name.encode(Encoding::UTF_8))
+        raise RbSDL2Error if ptr.null?
+        ptr.read_string.force_encoding(Encoding::UTF_8)
+      ensure
+        ::SDL2.SDL_free(ptr)
+      end
+    end
+  end
+end

data/lib/rb_sdl2/hint.rb

@@ -0,0 +1,24 @@
+module RbSDL2
+  module Hint
+    class << self
+      def [](name)
+        ptr = ::SDL2.SDL_GetHint(name.to_s)
+        ptr.null? ? nil : ptr.read_string
+      end
+
+      def []=(name, value)
+        bool = ::SDL2.SDL_SetHintWithPriority(name.to_s, value&.to_s, ::SDL2::SDL_HINT_OVERRIDE)
+        raise RbSDL2Error, "failed to set hint" if bool == ::SDL2::SDL_FALSE
+      end
+
+      def clear = ::SDL2.SDL_ClearHints
+
+      def freeze = raise(TypeError, "cannot freeze Hint")
+
+      def include?(name) = ::SDL2.SDL_GetHintBoolean(name, -1) != -1
+      alias has_key? include?
+      alias member? include?
+      alias key? include?
+    end
+  end
+end

data/lib/rb_sdl2/keyboard/key_mod.rb

@@ -0,0 +1,37 @@
+module RbSDL2
+  module Keyboard
+    module KeyMod
+      def mod_key? = ::SDL2::KMOD_NONE != mod
+
+      def l_shift_key? = ::SDL2::KMOD_LSHIFT & mod != 0
+
+      def r_shift_key? = ::SDL2::KMOD_RSHIFT & mod != 0
+
+      def l_ctrl_key? = ::SDL2::KMOD_LCTRL & mod != 0
+
+      def r_ctrl_key? = ::SDL2::KMOD_RCTRL & mod != 0
+
+      def l_alt_key? = ::SDL2::KMOD_LALT & mod != 0
+
+      def r_alt_key? = ::SDL2::KMOD_RALT & mod != 0
+
+      def l_gui_key? = ::SDL2::KMOD_LGUI & mod != 0
+
+      def r_gui_key? = ::SDL2::KMOD_RGUI & mod != 0
+
+      def alt_key? = ::SDL2::KMOD_ALT & mod != 0
+
+      def caps_key? = ::SDL2::KMOD_CAPS & mod != 0
+
+      def ctrl_key? = ::SDL2::KMOD_CTRL & mod != 0
+
+      def gui_key? = ::SDL2::KMOD_GUI & mod != 0
+
+      def mode_key? = ::SDL2::KMOD_MODE & mod != 0
+
+      def num_key? = ::SDL2::KMOD_NUM & mod != 0
+
+      def shift_key? = ::SDL2::KMOD_SHIFT & mod != 0
+    end
+  end
+end

data/lib/rb_sdl2/keyboard/keyboard_state.rb

@@ -0,0 +1,34 @@
+module RbSDL2
+  class KeyboardState
+    require 'singleton'
+    include Singleton
+
+    def initialize
+      num_keys = ::FFI::MemoryPointer.new(:int)
+      # SDL_GetKeyboardState が戻すポインターは SDL がロードされた時点でメモリー確保している。
+      # 戻されたポインターは不変と考えてよい。
+      # SDL_GetKeyboardState は SDL_init より前に呼ぶことができる。
+      # SDL_GetKeyboardState は引数に NULL ポインターを与えた場合にエラーを戻す。
+      @ptr = ::SDL2.SDL_GetKeyboardState(num_keys)
+      raise RbSDL2Error if @ptr.null?
+      @size = num_keys.read_int
+    end
+
+    # nth のキーが押されている場合、nth を戻す。
+    # nth のキーが押されていない、nth が範囲外の場合は nil を戻す。
+    # 真偽値を戻すようにしなかったのは、このメソッドを応用したコードを書く際に index 情報を不要にするためである。
+    # 戻り値が nil | obj なのは Numeric#nonzero? を参考にした。（この戻り値は Ruby において真偽値と同等である）
+    def [](nth)
+      if 0 <= nth && nth < size && @ptr[nth].read_uint8 == ::SDL2::SDL_PRESSED
+        nth
+      end
+    end
+
+    def each = block_given? ? size.times { |i| yield(self[i]) } : to_enum
+
+    attr_reader :size
+    alias length size
+
+    def to_str = @ptr.read_bytes(size)
+  end
+end

data/lib/rb_sdl2/keyboard.rb

@@ -0,0 +1,50 @@
+module RbSDL2
+  module Keyboard
+    class << self
+      def keycode_to_name(keycode) = ::SDL2.SDL_GetKeyName(keycode).read_string
+
+      # 対応するコードが存在しない場合 0 を戻す。戻り値 は nonzero? メソッドをチェーンすることができる。
+      # これは KeyboardState#[] での利用を考慮して設計した。
+      def keycode_to_scancode(keycode) = ::SDL2.SDL_GetScancodeFromKey(keycode)
+
+      def name_to_keycode(name) = ::SDL2.SDL_GetKeyFromName(name)
+
+      def name_to_scancode(name) = ::SDL2.SDL_GetScancodeFromName(name)
+
+      def scancode_to_keycode(scancode) = ::SDL2.SDL_GetKeyFromScancode(scancode)
+
+      def scancode_to_name(scancode) = ::SDL2.SDL_GetScancodeName(scancode).read_string
+    end
+
+    require 'forwardable'
+    extend SingleForwardable
+    require_relative 'keyboard/keyboard_state'
+    def_single_delegators 'KeyboardState.instance', *%i([] each to_str)
+
+    class << self
+      # いずれかのキーが押されている場合に true を戻す。つまり *any key* が押されたということ。
+      def any_key? = each.any?
+
+      # 引数に与えたキー名のキーが押されている場合に対応するスキャンコードを戻す。
+      # 押されていない場合は nil を戻す。
+      # 不正な名前の場合でも例外を戻さない、その場合 0 または nil を戻す。
+      # キー名は SDL が定義したものである。
+      def key?(name) = self[name_to_scancode(name)]
+
+      # 現在押されているキーの名前を配列で戻す。
+      def names = scancodes.map { |num| scancode_to_name(num) }
+
+      # 現在押されているキーのスキャンコードを配列で戻す。
+      def scancodes = each.to_a.compact!
+
+      def mod = ::SDL2.SDL_GetModState
+
+      require_relative 'keyboard/key_mod'
+      include KeyMod
+
+      def mod=(state)
+        ::SDL2::SDL_SetModState(state)
+      end
+    end
+  end
+end

data/lib/rb_sdl2/message_box.rb

@@ -0,0 +1,121 @@
+module RbSDL2
+  module MessageBox
+    class MessageBoxButtonDataArray
+      def initialize(num)
+        @entity_class = ::SDL2::SDL_MessageBoxButtonData
+        @ptr = ::FFI::MemoryPointer.new(@entity_class.size, num)
+      end
+
+      def [](nth) = @entity_class.new(@ptr + @entity_class.size * nth)
+
+      def to_ptr = @ptr
+    end
+
+    class MessageBoxData
+      def initialize(buttons: nil, colors: nil, escape_key: nil, level: nil, message: nil,
+                     return_key: nil, title: nil, window: nil)
+        @st = ::SDL2::SDL_MessageBoxData.new.tap do |data|
+          button_data = *buttons
+          data[:numbuttons] = num_buttons = button_data.length
+          data[:buttons] = @buttons = num_buttons.nonzero? &&
+            MessageBoxButtonDataArray.new(num_buttons).tap do |data_ary|
+              @button_texts = []
+              num_buttons.times do |idx|
+                st, (text, *) = data_ary[idx], button_data[idx]
+                st[:buttonid] = idx
+                st[:flags] = case idx
+                             when escape_key then ::SDL2::SDL_MESSAGEBOX_BUTTON_ESCAPEKEY_DEFAULT
+                             when return_key then ::SDL2::SDL_MESSAGEBOX_BUTTON_RETURNKEY_DEFAULT
+                             else 0
+                             end
+                st[:text] = @button_texts[idx] =
+                  ::FFI::MemoryPointer.from_string(text.to_s.encode(Encoding::UTF_8))
+              end
+            end
+          data[:colorScheme] = @color_scheme = colors &&
+            ::SDL2::SDL_MessageBoxColorScheme.new.tap do |st|
+              # r, g, b, a 形式だった場合にエラーを出さない。
+              st[:colors].each.with_index { |c, i| c[:r], c[:g], c[:b] = colors[i] }
+            end
+          data[:flags] = MessageBoxFlags.to_num(level)
+          data[:message] = @message =
+            ::FFI::MemoryPointer.from_string(message.to_s.encode(Encoding::UTF_8))
+          data[:title] = @title =
+            ::FFI::MemoryPointer.from_string(title.to_s.encode(Encoding::UTF_8))
+          data[:window] = window
+        end
+      end
+
+      def to_ptr = @st.to_ptr
+    end
+
+    module MessageBoxFlags
+      class << self
+        def to_num(obj)
+          case obj
+          when /\Aerror/ then ::SDL2::SDL_MESSAGEBOX_ERROR
+          when /\Ainfo/ then ::SDL2::SDL_MESSAGEBOX_INFORMATION
+          when /\Awarn/ then ::SDL2::SDL_MESSAGEBOX_WARNING
+          when nil then 0
+          else
+            raise ArgumentError
+          end
+        end
+      end
+    end
+
+    CONFIRMATION_OPTIONS = { buttons: { Cancel: false, OK: true }, default: true }.freeze
+
+    class << self
+      def alert(msg = nil, window = nil, level: nil, message: msg, title: nil)
+        err = ::SDL2.SDL_ShowSimpleMessageBox(MessageBoxFlags.to_num(level),
+                                              title&.to_s&.encode(Encoding::UTF_8),
+                                              message&.to_s&.encode(Encoding::UTF_8),
+                                              window)
+        raise RbSDL2Error if err < 0
+      end
+
+      def confirm(*args, **opts) = dialog(*args, **opts.merge!(CONFIRMATION_OPTIONS))
+
+      # buttons: "label" | ["label",...] | [["label", obj],...] | {"label" => obj,...}
+      # buttons １個以上のオブジェクトがあること。０個の場合はエラーになる。
+      # colors: [[r,g,b],...] | nil
+      # 環境（例えば Win10）によっては colors は反映されない。 nil の場合はシステム設定のカラーが使用される。
+      # ユーザがクリックしたボタンに応じたオブジェクトが戻る。
+      # ユーザが Escape キーが押した場合（何も選択しなかった場合）ブロックが与えられていればブロックの評価内容が、
+      # ブロックがなければ nil が戻る。
+      def dialog(msg = nil, window = nil, buttons:, message: msg, **opts)
+        button_data = *buttons
+        raise ArgumentError if button_data.empty?
+        # Escape キーの割り当ては可能だが行わないようにした。
+        # Return キーと Escape キーの割り当てが同じ場合に Return キーは機能しなくなる。
+        if opts.key?(:default)
+          opts.merge!(return_key: button_data.index { |*, obj| obj == opts[:default] })
+          opts.delete(:default)
+        end
+        ptr = ::FFI::MemoryPointer.new(:int)
+        data = MessageBoxData.new(buttons: button_data, message: message, window: window, **opts)
+        err = ::SDL2.SDL_ShowMessageBox(data, ptr)
+        raise RbSDL2Error if err < 0
+        # (Escape キーの割り当てがない場合に) Escape キーが押された場合 idx = -1
+        if (idx = ptr.read_int) < 0
+          block_given? ? yield : nil
+        else
+          button_data[idx]
+        end
+      end
+
+      def error(*args, title: :Error, **opts)
+        alert(*args, title: title, **opts.merge!(level: :error))
+      end
+
+      def info(*args, title: :Information, **opts)
+        alert(*args, title: title, **opts.merge!(level: :info))
+      end
+
+      def warn(*args, title: :Warning, **opts)
+        alert(*args, title: title, **opts.merge!(level: :warn))
+      end
+    end
+  end
+end

data/lib/rb_sdl2/mouse/global_mouse.rb

@@ -0,0 +1,18 @@
+module RbSDL2
+  module Mouse
+    require_relative 'mouse_class'
+
+    class GlobalMouse < MouseClass
+      def position=(x_y)
+        err = ::SDL2.SDL_WarpMouseGlobal(*x_y)
+        raise RbSDL2Error if err < 0
+        update
+      end
+
+      def update
+        self.button = ::SDL2.SDL_GetGlobalMouseState(x_ptr, y_ptr)
+        self
+      end
+    end
+  end
+end

data/lib/rb_sdl2/mouse/mouse_button.rb

@@ -0,0 +1,24 @@
+module RbSDL2
+  module Mouse
+    module MouseButton
+      SDL_BUTTON = -> (x) { 1 << x - 1 }
+      SDL_BUTTON_LMASK  = SDL_BUTTON.(::SDL2::SDL_BUTTON_LEFT)
+      SDL_BUTTON_MMASK  = SDL_BUTTON.(::SDL2::SDL_BUTTON_MIDDLE)
+      SDL_BUTTON_RMASK  = SDL_BUTTON.(::SDL2::SDL_BUTTON_RIGHT)
+      SDL_BUTTON_X1MASK = SDL_BUTTON.(::SDL2::SDL_BUTTON_X1)
+      SDL_BUTTON_X2MASK = SDL_BUTTON.(::SDL2::SDL_BUTTON_X2)
+
+      def any_button? = button != 0
+
+      def left_button? = SDL_BUTTON_LMASK & button != 0
+
+      def middle_button? = SDL_BUTTON_MMASK & button != 0
+
+      def right_button? = SDL_BUTTON_RMASK & button != 0
+
+      def x1_button? = SDL_BUTTON_X1MASK & button != 0
+
+      def x2_button? = SDL_BUTTON_X2MASK & button != 0
+    end
+  end
+end

data/lib/rb_sdl2/mouse/mouse_class.rb

@@ -0,0 +1,33 @@
+module RbSDL2
+  module Mouse
+    class MouseClass
+      require 'singleton'
+      include Singleton
+
+      def initialize
+        @button = 0
+        @x_ptr, @y_ptr = Array.new(2) { ::FFI::MemoryPointer.new(:int) }
+      end
+
+      attr_reader :button
+      private attr_writer :button
+
+      require_relative 'mouse_button'
+      include MouseButton
+
+      def position = [x, y]
+
+      # 継承先のクラスではこのメソッドをオーバーライドすること。
+      # 戻り値は self が戻ることが期待されている。
+      def update = self
+
+      private attr_reader :x_ptr
+
+      def x = x_ptr.read_int
+
+      private attr_reader :y_ptr
+
+      def y = y_ptr.read_int
+    end
+  end
+end

data/lib/rb_sdl2/mouse/mouse_wheel.rb

@@ -0,0 +1,53 @@
+module RbSDL2
+  module Mouse
+    class MouseWheel
+      @timestamp = @x = @y = 0
+      @mutex = Mutex.new
+
+      MOUSE_WHEEL_EVENT_WATCH = -> (event, _) {
+        if event.mouse_wheel?
+          a = event[:direction] == ::SDL2::SDL_MOUSEWHEEL_FLIPPED ? -1 : 1
+          @timestamp = event[:timestamp]
+          @x = event[:x] * a
+          @y = event[:y] * a
+        end
+      }
+
+      class << self
+        attr_reader :timestamp, :x, :y
+
+        require_relative '../event'
+
+        def wheel=(bool)
+          @mutex.synchronize do
+            if bool
+              Event.add_watch_callback(MOUSE_WHEEL_EVENT_WATCH)
+            else
+              Event.remove_watch_callback(MOUSE_WHEEL_EVENT_WATCH)
+            end
+          end
+        end
+      end
+
+      require 'singleton'
+      include Singleton
+
+      def initialize
+        @timestamp = @x = @y = 0
+      end
+
+      def position = [x, y]
+
+      def update
+        if @timestamp != MouseWheel.timestamp
+          @x, @y, @timestamp = MouseWheel.x, MouseWheel.y, MouseWheel.timestamp
+        else
+          @x, @y = 0, 0
+        end
+        self
+      end
+
+      attr_reader :x, :y
+    end
+  end
+end

data/lib/rb_sdl2/mouse/relative_mouse.rb

@@ -0,0 +1,12 @@
+module RbSDL2
+  module Mouse
+    require_relative 'mouse_class'
+
+    class RelativeMouse < MouseClass
+      def update
+        self.button = ::SDL2.SDL_GetRelativeMouseState(x_ptr, y_ptr)
+        self
+      end
+    end
+  end
+end

data/lib/rb_sdl2/mouse/window_mouse.rb

@@ -0,0 +1,17 @@
+module RbSDL2
+  module Mouse
+    require_relative 'mouse_class'
+
+    class WindowMouse < MouseClass
+      def position=(*x_y)
+        ptr = ::SDL2.SDL_GetMouseFocus
+        ::SDL2.SDL_WarpMouseInWindow(ptr, *x_y) unless ptr.null?
+      end
+
+      def update
+        self.button = ::SDL2.SDL_GetMouseState(x_ptr, y_ptr)
+        self
+      end
+    end
+  end
+end