SDLRuby 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 7516a8b356b287a6f985881964b1a44f76922354a13d70000b9990dd2a67badd
+  data.tar.gz: 358b7f4a6b40bd7a31e7249beaac18f77d3d7a08b21c9802f30203fce36628ed
+SHA512:
+  metadata.gz: b5f6c08130fa89f6aa74009a02a5d4a7ada123839f0a2eef2894347ac358e0e75b188bbfd0a657004be3d54207166484b8b842b43edb5ee5dbf6340c4f13f095
+  data.tar.gz: 26017bbb155bb41c032396b13e9981ee62c72954b66501b2ab818356a9cedcbb295a74f810f742ecaf83b1ba52dd6c69b658e39859b35443a59f575fe0d72423

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2023-08-30
+
+- Initial release

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 shinokaro
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# SDLRuby
+
+SDLRuby is a GEM that allows calling the SDL library from Ruby, enabling window creation, image display, audio playback, and more. It easily manages C pointers as Ruby objects, all written in 100% Ruby. Achieve multimedia programming simplicity.
+
+## Installation
+
+Install the gem and add to the application's Gemfile by executing:
+
+    $ bundle add SDLRuby
+
+If bundler is not being used to manage dependencies, install the gem by executing:
+
+    $ gem install SDLRuby
+
+## Usage
+
+**⚠️UNDER CONSTRUCTION⚠️**
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/shinokaro/SDLRuby.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/test_*.rb"]
+end
+
+task default: :test

data/lib/SDLRuby/audio.rb

@@ -0,0 +1,65 @@
+module SDLRuby
+  module Audio
+    include SDL
+
+    class << self
+      include SDL
+
+      def default_device(capture: nil)
+        name = SDL.tmp_value("void*")
+        spec = SDL_AudioSpec.malloc(Fiddle::RUBY_FREE)
+        is_capture = capture ? 1 : 0
+        err = SDL. SDL_GetDefaultAudioInfo(name, spec, is_capture)
+        raise SDLError if err != 0
+
+        ptr = name.value
+        s = if ptr.null?
+              nil
+            else
+              ptr.free = SDL_FREE
+              ptr.to_s.force_encoding("UTF-8")
+            end
+
+        [s, spec.to_h]
+      end
+
+      def devices(capture: nil)
+        is_capture = capture ? 1 : 0
+        num = SDL.SDL_GetNumAudioDevices(is_capture)
+        num.times.map do |idx|
+          SDL.SDL_GetAudioDeviceName(idx, is_capture).to_s.force_encoding("UTF-8")
+        end
+      end
+
+      def device_spec(name, capture: nil)
+        idx = devices(capture: capture).index(name.encode("UTF-8"))
+
+        return unless idx
+
+        is_capture = capture ? 1 : 0
+        spec = SDL_AudioSpec.malloc(Fiddle::RUBY_FREE)
+
+        if SDL.SDL_GetAudioDeviceSpec(idx, is_capture, spec) == 0
+          spec.to_h
+        end
+      end
+
+      def driver
+        ptr = SDL.SDL_GetCurrentAudioDriver
+        ptr.null? ? nil : ptr.to_s
+      end
+
+      def drivers
+        num = SDL.SDL_GetNumAudioDrivers
+        num.times.map { |idx| SDL.SDL_GetAudioDriver(idx).to_s }
+      end
+
+      def init(driver)
+        err = SDL.SDL_AudioInit(driver)
+        raise SDLError if err < 0
+      end
+
+      def quit = SDL.SDL_AudioQuit
+    end
+  end
+end

data/lib/SDLRuby/cursor.rb

@@ -0,0 +1,46 @@
+module SDLRuby
+  class Cursor
+    include SDL
+
+    class << self
+      def [](obj, hot: nil)
+        case obj
+        when Surface
+          SDL.SDL_CreateColorCursor(obj, *hot && [0, 0])
+        when Integer
+          SDL.SDL_CreateSystemCursor(obj)
+        else
+          raise ArgumentError
+        end => ptr
+
+        raise SDLError if ptr.null?
+
+        new(ptr)
+      end
+
+      def default! = SDL.SDL_SetCursor(SDL.SDL_GetDefaultCursor)
+
+      def hide = SDL.SDL_ShowCursor(0)
+
+      def redraw = SDL.SDL_SetCursor(nil)
+
+      def show = SDL.SDL_ShowCursor(1)
+
+      def shown? = SDL.SDL_ShowCursor(-1) == 1
+    end
+
+    def initialize(ptr)
+      ptr.free = SDL_FREE_CURSOR
+      @ptr = ptr
+    end
+
+    def current? = SDL.SDL_GetCursor == @ptr
+
+    def show
+      SDL.SDL_SetCursor(self)
+      Cursor.show
+    end
+
+    def to_ptr = @ptr
+  end
+end

data/lib/SDLRuby/display.rb

@@ -0,0 +1,79 @@
+require_relative 'pixel_formatter'
+
+module SDLRuby
+  class DisplayMode
+    include PixelFormatter, SDL
+    extend Forwardable
+
+    def initialize
+      @st = SDL_DisplayMode.malloc(Fiddle::RUBY_FREE)
+    end
+
+    def_delegators :@st, :format, :w, :h, :refresh_rate
+
+    def to_ptr = @st.to_ptr
+  end
+
+  class Display
+    class << self
+      include SDL
+
+      # Videoの初期化がされていなければ0を戻す。
+      #
+      def count = (i = SDL.SDL_GetNumVideoDisplays) < 0 ? 0 : i
+
+      def orientation(idx) = SDL.SDL_GetDisplayOrientation(idx)
+
+      def orientation_name(idx)
+        case orientation(idx)
+        when SDL_ORIENTATION_UNKNOWN           then ""
+        when SDL_ORIENTATION_LANDSCAPE         then "landscape"
+        when SDL_ORIENTATION_LANDSCAPE_FLIPPED then "landscape_flipped"
+        when SDL_ORIENTATION_PORTRAIT          then "portrait"
+        when SDL_ORIENTATION_PORTRAIT_FLIPPED  then "portrait_flipped"
+        else
+          ""
+        end
+      end
+    end
+
+    attr_reader :bounds, :current_display_mode, :desktop_display_mode,
+                :display_modes, :name, :orientation, :usable_bounds
+
+    def initialize(num)
+      # この実装では例外を出さない。
+      # 基本的にSDLの内部構造体を読み出しているだけであり、
+      # 関数からのエラー報告はインデックス境界に関するものである。
+      #
+      # ディスプレイの状態はユーザのハードウェアやOS操作によって常に変化する。
+      # 一纏めにデータを取得する必要がある。
+      #
+      @bounds = Rect[].tap { |r| SDL.SDL_GetDisplayBounds(num, r) }.to_a
+
+      @current_display_mode = DisplayMode.new.tap do |st|
+        SDL.SDL_GetCurrentDisplayMode(num, st)
+      end
+
+      @desktop_display_mode = DisplayMode.new.tap do |st|
+        SDL.SDL_GetDesktopDisplayMode(num, st)
+      end
+
+      @display_modes = SDL.SDL_GetNumDisplayModes(num).times.map do |idx|
+        DisplayMode.new.tap { |st| SDL.SDL_GetDisplayMode(num, idx, st) }
+      end
+
+      ptr = SDL.SDL_GetDisplayName(num)
+      @name = (ptr.null? ? nil : ptr).to_s.force_encoding("UTF-8")
+
+      @orientation = Display.orientation(num)
+
+      @usable_bounds = Rect[].tap do |r|
+        SDL.SDL_GetDisplayUsableBounds(num, r)
+      end.to_a
+
+      @num = num
+    end
+
+    def to_i = @num
+  end
+end

data/lib/SDLRuby/event/accessor.rb

@@ -0,0 +1,127 @@
+module SDLRuby
+  class Event
+    module Accessor
+      include SDL
+
+      union_members = SDL_Event.members.inject([]) do |result, (name, members)|
+        if members
+          # ネストした構造体の場合は親のみを選択する。
+          result << [name, members.flatten(1).select { |a| !(Array === a) }]
+        end
+
+        result
+      end
+
+      @modules = Hash.new do |_, key|
+        raise KeyError, "undefined SDL_Event member(#{key})"
+      end
+
+      union_members.each do |name, members|
+        @modules[name.to_sym] = Module.new do
+          extend Forwardable
+
+          def_delegators :entity, *members
+        end
+      end
+
+      class << self
+        def [](sym) = @modules[sym]
+      end
+
+      self[:adevice].module_eval do
+        def capture? = entity.iscapture != 0
+      end
+
+      self[:cbutton].module_eval do
+        def pressed? = state == SDL_PRESSED
+      end
+
+      self[:drop].module_eval do
+        undef file
+
+        def file = char_ptr_to_str(entity.file)
+
+        alias_method :text, :file
+
+        def self.extended(obj)
+          @_ptr ||= entity.file.tap { |ptr| ptr.free = SDL_FREE unless ptr.null? }
+        end
+      end
+
+      self[:edit].module_eval  do
+        undef text
+
+        def text = char_ary_to_str(entity.text)
+      end
+
+      self[:editExt].module_eval do
+        undef text
+
+        def text = char_ptr_to_str(entity.text)
+
+        def self.extended(obj)
+          @_ptr ||= entity.text.tap { |ptr| ptr.free = SDL_FREE }
+        end
+      end
+
+      self[:jbutton].module_eval do
+        def pressed? = state == SDL_PRESSED
+      end
+
+      self[:key].module_eval do
+        undef keysym
+
+        def keysym = entity.keysym.to_h
+      end
+
+      self[:syswm].module_eval do
+        undef msg
+
+        def msg = entity.msg
+      end
+
+      self[:text].module_eval do
+        undef text
+
+        def text = char_ary_to_str(entity.text)
+      end
+
+      self[:user].module_eval do
+        undef data1, data2
+
+        def data1 = entity.data1
+
+        def data2 = entity.data2
+      end
+
+      # STIの実装としてメンバー全てのゲッターに例外を出さず応答するようにする。
+      # これは"y"メソッドにRubyが応答してしまうため。事前にオーバーライドしておく。
+      #
+      all_members = union_members.map { |a| a.last }.flatten.uniq
+
+      attr_reader(*all_members)
+
+      # Ruby like accessor
+      #
+      alias_method :d_dist, :dDist
+      alias_method :d_theta, :dTheta
+      alias_method :finger_id, :fingerId
+      alias_method :gesture_id, :gestureId
+      alias_method :mouse_x, :mouseX
+      alias_method :mouse_y, :mouseY
+      alias_method :num_fingers, :numFingers
+      alias_method :precise_x, :preciseX
+      alias_method :precise_y, :preciseY
+      alias_method :touch_id, :touchId
+      alias_method :window_id, :windowID
+
+      private def char_ary_to_str(a)
+        a[0, a.find_index(0)].pack("C*").force_encoding("UTF-8")
+      end
+
+      private def char_ptr_to_str(ptr)
+        ptr.null? ? "" : ptr.to_s.force_encoding("UTF-8")
+      end
+    end
+  end
+end

data/lib/SDLRuby/event/type.rb

@@ -0,0 +1,75 @@
+module SDLRuby
+  class Event
+    module Type
+      include SDL
+
+      QUIT_EVENT = SDL_QUIT..SDL_QUIT
+      DISPLAY_EVENT = SDL_DISPLAYEVENT..SDL_DISPLAYEVENT
+      WINDOW_EVENT = SDL_WINDOWEVENT..SDL_WINDOWEVENT
+      SYSWM_EVENT = SDL_SYSWMEVENT..SDL_SYSWMEVENT
+      KEY_EVENT = SDL_KEYDOWN..SDL_KEYUP
+      EDIT_EVENT = SDL_TEXTEDITING..SDL_TEXTEDITING
+      TEXT_EVENT = SDL_TEXTINPUT..SDL_TEXTINPUT
+      EDIT_EXT_EVENT = SDL_TEXTEDITING_EXT..SDL_TEXTEDITING_EXT
+      MOTION_EVENT = SDL_MOUSEMOTION..SDL_MOUSEMOTION
+      BUTTON_EVENT = SDL_MOUSEBUTTONDOWN..SDL_MOUSEBUTTONUP
+      WHEEL_EVENT = SDL_MOUSEWHEEL..SDL_MOUSEWHEEL
+      JAXIS_EVENT = SDL_JOYAXISMOTION..SDL_JOYAXISMOTION
+      JBALL_EVENT = SDL_JOYBALLMOTION..SDL_JOYBALLMOTION
+      JHAT_EVENT = SDL_JOYHATMOTION..SDL_JOYHATMOTION
+      JBUTTON_EVENT = SDL_JOYBUTTONDOWN..SDL_JOYBUTTONUP
+      JDEVICE_EVENT = SDL_JOYDEVICEADDED..SDL_JOYDEVICEREMOVED
+      JBATTERY_EVENT = SDL_JOYBATTERYUPDATED..SDL_JOYBATTERYUPDATED
+      CAXIS_EVENT = SDL_CONTROLLERAXISMOTION..SDL_CONTROLLERAXISMOTION
+      CBUTTON_EVENT = SDL_CONTROLLERBUTTONDOWN..SDL_CONTROLLERBUTTONUP
+      CDEVICE_EVENT = SDL_CONTROLLERDEVICEADDED..SDL_CONTROLLERDEVICEREMAPPED
+      CTOUCHPAD_EVENT = SDL_CONTROLLERTOUCHPADDOWN..SDL_CONTROLLERTOUCHPADUP
+      CSENSOR_EVENT = SDL_CONTROLLERSENSORUPDATE..SDL_CONTROLLERSENSORUPDATE
+      TFINGER_EVENT = SDL_FINGERDOWN..SDL_FINGERMOTION
+      DGESTURE_EVENT = SDL_DOLLARGESTURE..SDL_DOLLARRECORD
+      MGESTURE_EVENT = SDL_MULTIGESTURE..SDL_MULTIGESTURE
+      DROP_EVENT = SDL_DROPFILE..SDL_DROPCOMPLETE
+      ADEVICE_EVENT = SDL_AUDIODEVICEADDED..SDL_AUDIODEVICEREMOVED
+      SENSOR_EVENT = SDL_SENSORUPDATE..SDL_SENSORUPDATE
+      USER_EVENT = SDL_USEREVENT...SDL_LASTEVENT
+
+      class << self
+        def to_sym(type)
+          case type
+          when DISPLAY_EVENT   then :display
+          when WINDOW_EVENT    then :window
+          when KEY_EVENT       then :key
+          when EDIT_EVENT      then :edit
+          when EDIT_EXT_EVENT  then :editExt
+          when TEXT_EVENT      then :text
+          when MOTION_EVENT    then :motion
+          when BUTTON_EVENT    then :button
+          when WHEEL_EVENT     then :wheel
+          when JAXIS_EVENT     then :jaxis
+          when JBALL_EVENT     then :jball
+          when JHAT_EVENT      then :jhat
+          when JBUTTON_EVENT   then :jbutton
+          when JDEVICE_EVENT   then :jdevice
+          when JBATTERY_EVENT  then :jbattery
+          when CAXIS_EVENT     then :caxis
+          when CBUTTON_EVENT   then :cbutton
+          when CDEVICE_EVENT   then :cdevice
+          when CTOUCHPAD_EVENT then :ctouchpad
+          when CSENSOR_EVENT   then :csensor
+          when ADEVICE_EVENT   then :adevice
+          when SENSOR_EVENT    then :sensor
+          when QUIT_EVENT      then :quit
+          when USER_EVENT      then :user
+          when SYSWM_EVENT     then :syswm
+          when TFINGER_EVENT   then :tfinger
+          when MGESTURE_EVENT  then :mgesture
+          when DGESTURE_EVENT  then :dgesture
+          when DROP_EVENT      then :drop
+          else
+            :common
+          end
+        end
+      end
+    end
+  end
+end

data/lib/SDLRuby/event.rb

@@ -0,0 +1,80 @@
+require_relative 'event/accessor'
+require_relative 'event/type'
+
+module SDLRuby
+  class Event
+    include Accessor, Fiddle, SDL
+
+    class << self
+      include SDL
+
+      # SDL_WaitEvent, SDL_WaitEventTimeoutはRubyのスレッドを停止させるため実装しない。
+      #   ※C関数呼び出し時にGVLを外せれば可能か？
+      # SDL_RegisterEventsはSDLに対応するゲッターがないため実装しない。
+      # SDL_PushEventは必要ならば実装する。ただしEventコンストラクターを含むため規模が大きい。
+      #
+      # SDL_AddEventWatch, SDL_SetEventFilterおよびSDL_FilterEventsは実装しない。
+      #   イベントにポインターを含む場合、RubyのGCの管理下に置く方法が複雑なため。
+      #   ※現実装ではイベントを取り込んだ時点でポインターをRubyの管理下に置いている。
+      #   メンバーのポインター管理をファイナライザーに移行できれば可能だろう。
+      #   ※そしてファイナライザーを設定するかどうか選択する。
+      #   いずれもSDL_EventPumpを呼び出さなければ動作しない。
+      #   非同期にイベントを取得できるわけではない。
+      # SDL_PeepEventsは実装しない。
+      #   SDL_ADDEVENT:
+      #     イベントのメンバーにポインターを含む場合、それのSDL側へのコピーが必要になる。
+      #     SDL_PushEventが実装されれば、それが同等の機能を持つ。
+      #   SDL_PEEKEVENT:
+      #     SDL_FilterEventsが実装できれば、それが同等の機能を持つ。
+      #   SDL_GETEVENT:
+      #     キューの削除が目的だと思う。それを行うならSDL_PollEventを利用して欲しい。
+      #     イベントキューはコレクションではない。
+      #
+      #   SDL_PeepEventsは実行中にキューをロックすることに注意。
+      #   また、SDL_SYSWMEVENTのmsgメンバーにコピーが必要か分からない。（要調査）
+      #   ※このポインターだけSDLが管理しているようだ。
+
+      def clear = (pump or flash)
+
+      def count = SDL.SDL_PeepEvents(nil, 0, SDL_PEEKEVENT, 0, -1)
+
+      def disable(type) = SDL.SDL_EventState(type, 0)
+
+      def enable(type) = SDL.SDL_EventState(type, 1)
+
+      def flash = SDL.SDL_FlushEvents(SDL_FIRSTEVENT, SDL_LASTEVENT)
+
+      def get = poll(e = new)
+
+      private :new
+
+      private def poll(e) = (SDL.SDL_PollEvent(e).nonzero? and e.update)
+
+      def pump = SDL.SDL_PumpEvents
+
+      alias update pump
+
+      def quit? = (pump or SDL.SDL_HasEvent(SDL_QUIT) != 0)
+    end
+
+    def initialize
+      @st = SDL_Event.malloc(RUBY_FREE)
+    end
+
+    private attr_reader :entity
+
+    def to_ptr = @st.to_ptr
+
+    def to_sym = Type.to_sym(@st.type)
+
+    def update
+      unless @entity
+        sym = to_sym
+        @entity = @st.__send__(sym)
+        extend(Accessor[sym])
+      end
+
+      self
+    end
+  end
+end