SDLRuby 0.2.1 → 0.3.1

data/lib/SDLRuby/sdl.rb

@@ -1,191 +1,218 @@
-require "fiddle/import"
-
-module SDLRuby
-  module SDL
-    extend Fiddle::Importer
-
-    dlload "SDL2"
-
-    SDL_DESTROY_RENDERER = import_symbol("SDL_DestroyRenderer").to_int
-    SDL_DESTROY_TEXTURE = import_symbol("SDL_DestroyTexture").to_int
-
-    # SDL_freeはSDL_SetMemoryFunctionsで設定された関数を使用する。
-    # SDL側のメモリーを開放する場合はFiddle::PointerへSDL_FREEを設定してよい。
-    #
-    SDL_FREE = SDL.import_symbol("SDL_free").to_int
-    SDL_FREE_CURSOR = import_symbol("SDL_FreeCursor").to_int
-    SDL_FREE_FORMAT = import_symbol("SDL_FreeFormat").to_int
-    SDL_FREE_PALETTE = import_symbol("SDL_FreePalette").to_int
-    SDL_FREE_RW = import_symbol("SDL_FreeRW").to_int
-    SDL_FREE_SURFACE = import_symbol("SDL_FreeSurface").to_int
-
-    def self.tmp_value(*a, &)
-      raise ArgumentError if a.empty?
-
-      a.map { |ty|
-        st = create_value(ty)
-        st.to_ptr.free = Fiddle::RUBY_FREE
-        st
-      } => vals
-
-      v = vals.one? ? vals.first : vals
-      block_given? ? yield(*v) : v
-    end
-
-    require_relative 'sdl/sdl'
-    require_relative 'sdl_error'
-
-    require_relative 'audio'
-    require_relative 'cursor'
-    require_relative 'display'
-    require_relative 'event'
-    require_relative 'hint'
-    require_relative 'keyboard'
-    require_relative 'mouse'
-    require_relative 'palette'
-    require_relative 'pixel_formatter'
-    require_relative 'rect'
-    require_relative 'renderer'
-    require_relative 'rw_ops'
-    require_relative 'surface'
-    require_relative 'text_input'
-    require_relative 'texture'
-    require_relative 'window'
-
-    class << self
-      # sdl
-      #
-      def init(flags = nil)
-        err = SDL.SDL_Init(flags || SDL_INIT_EVERYTHING)
-        raise SDLError if err < 0
-      end
-
-      def init?(flags) = SDL.WasInit(flags).nonzero?
-
-      def quit = SDL.SDL_Quit
-
-      # clipboard
-      #
-      def clipboard_text
-        ptr = SDL.SDL_GetClipboardText
-        raise SDLError if ptr.null?
-
-        ptr.free = SDL_FREE
-        ptr.to_s.force_encoding("UTF-8")
-      end
-
-      def clipboard_text? = SDL.SDL_HasClipboardText == 1
-
-      def clipboard_text=(s)
-        err = SDL.SDL_SetClipboardText(s.to_s.encode("UTF-8"))
-        raise SDLError if err < 0
-      end
-
-      # cpu info
-      #
-      def cpu_cache_line_size = SDL.SDL_GetCPUCacheLineSize
-
-      def cpu_count = SDL.SDL_GetCPUCount
-
-      def system_ram = SDL.SDL_GetSystemRAM
-
-      # error
-      #
-      def last_error_message = SDL.SDL_GetError.to_s
-
-      def last_error_message=(s)
-        SDL.SDL_SetError(s.to_s.gsub(/%/, "%%"))
-      end
-
-      # filesystem
-      #
-      def base_path
-        ptr = SDL.SDL_GetBasePath
-        raise SDLError if ptr.null?
-
-        ptr.free = SDL_FREE
-        ptr.to_s
-      end
-
-      # locale
-      #
-      def locales
-        ptr = SDL.SDL_GetPreferredLocales
-        return [] if ptr.null?
-
-        ptr.free = SDL_FREE
-        size = SDL_Locale.size
-        (0..).inject([]) do |memo, i|
-          st = SDL_Locale.new(ptr + i * size)
-          break memo if st.language.null?
-          memo << [st.language.to_s,
-                   (c = st.country).null? ? nil : c.to_s]
-        end
-      end
-
-      # message box
-      #
-      def alert(message, title = nil, flags: nil, window: nil)
-        err = SDL.SDL_ShowSimpleMessageBox(flags,
-                                           title.to_s.encode("UTF-8"),
-                                           message.to_s.encode("UTF-8"),
-                                           window)
-        raise SDLError if err < 0
-      end
-
-      def error_alert(message, title = "Error")
-        alert(message, title, flags: SDL_MESSAGEBOX_ERROR)
-      end
-
-      def warn_alert(message, title = "Warning")
-        alert(message, title, flags: SDL_MESSAGEBOX_WARNING)
-      end
-
-      def info_alert(message, title = "Information")
-        alert(message, title, flags: SDL_MESSAGEBOX_INFORMATION)
-      end
-
-      # misc
-      #
-      def open_url(url)
-        raise SDLError if SDL.SDL_OpenURL(url) < 0
-      end
-
-      # platform
-      #
-      def platform = SDL.SDL_GetPlatform.to_s
-
-      # timer
-      #
-      def ticks = SDL.SDL_GetTicks
-
-      # version
-      #
-      def revision = SDL.SDL_GetRevision.to_s
-
-      def version
-        st = SDL_version.malloc(Fiddle::RUBY_FREE)
-        SDL.SDL_GetVersion(st)
-        st.to_a.join(".")
-      end
-
-      # video
-      #
-      def video_driver
-        (ptr = SDL.SDL_GetCurrentVideoDriver).null? ? nil : ptr.to_s
-      end
-
-      def screen_saver=(b)
-        b ? SDL.SDL_EnableScreenSaver : SDL.SDL_DisableScreenSaver
-      end
-
-      def screen_saver? = SDL.SDL_IsScreenSaverEnabled != 0
-
-      def video_drivers
-        SDL.SDL_GetNumVideoDrivers.times.map do |i|
-          (ptr = SDL.SDL_GetVideoDriver(i)).null? ? nil : ptr.to_s
-        end
-      end
-    end
-  end
-end
+require "fiddle/import"
+
+module SDLRuby
+  module SDL
+    extend Fiddle::Importer
+
+    dlload "SDL2"
+
+    SDL_DESTROY_RENDERER = import_symbol("SDL_DestroyRenderer").to_int
+    SDL_DESTROY_TEXTURE  = import_symbol("SDL_DestroyTexture").to_int
+
+    # SDL_freeはSDL_SetMemoryFunctionsで設定された関数を使用する。
+    # SDL側のメモリーを開放する場合はFiddle::PointerへSDL_FREEを設定してよい。
+    #
+    SDL_FREE         = import_symbol("SDL_free").to_int
+    SDL_FREE_CURSOR  = import_symbol("SDL_FreeCursor").to_int
+    SDL_FREE_FORMAT  = import_symbol("SDL_FreeFormat").to_int
+    SDL_FREE_PALETTE = import_symbol("SDL_FreePalette").to_int
+    SDL_FREE_RW      = import_symbol("SDL_FreeRW").to_int
+    SDL_FREE_SURFACE = import_symbol("SDL_FreeSurface").to_int
+
+    def self.tmp_value(*a, &)
+      raise ArgumentError if a.empty?
+
+      a.map { |ty|
+        st = create_value(ty)
+        st.to_ptr.free = Fiddle::RUBY_FREE
+        st
+      } => vals
+
+      v = vals.one? ? vals.first : vals
+      block_given? ? yield(*v) : v
+    end
+
+    require_relative 'sdl/sdl'
+    require_relative 'sdl_error'
+
+    require_relative 'audio'
+    require_relative 'cursor'
+    require_relative 'display'
+    require_relative 'event'
+    require_relative 'hint'
+    require_relative 'keyboard'
+    require_relative 'mouse'
+    require_relative 'palette'
+    require_relative 'pixel_formatter'
+    require_relative 'rect'
+    require_relative 'renderer'
+    require_relative 'rw_ops'
+    require_relative 'surface'
+    require_relative 'text_input'
+    require_relative 'texture'
+    require_relative 'timer'
+    require_relative 'window'
+
+    class << self
+      # sdl
+      #
+      def init(flags = nil)
+        err = SDL.SDL_Init(flags || SDL_INIT_EVERYTHING)
+        raise SDLError if err < 0
+      end
+
+      # Description:
+      #
+      # This method checks the initialization status of SDL subsystems based on
+      # the provided flags. You can specify the SDL subsystems you want to check
+      # by combining the SDL_INIT_* flags using bitwise OR.
+      #
+      # Parameters:
+      #
+      # flags (optional): An integer or a combination of SDL_INIT_* flags
+      # representing the SDL subsystems to check. Default is nil.
+      #
+      # Return Value:
+      #
+      # If all the specified SDL subsystems in flags are initialized,
+      # the method returns true.
+      # If any of the specified SDL subsystems are not initialized,
+      # it returns false.
+      # If flags is given as nil or 0,
+      # the method returns true if any of the SDL subsystems are initialized.
+      #
+      def init?(flags = nil)
+        if flags && flags != 0
+          SDL.SDL_WasInit(flags) == flags
+        else
+          SDL.SDL_WasInit(0) != 0
+        end
+      end
+
+      def quit = SDL.SDL_Quit
+
+      # clipboard
+      #
+      def clipboard_text
+        ptr = SDL.SDL_GetClipboardText
+        raise SDLError if ptr.null?
+
+        ptr.free = SDL_FREE
+        ptr.to_s.force_encoding("UTF-8")
+      end
+
+      def clipboard_text? = SDL.SDL_HasClipboardText == 1
+
+      def clipboard_text=(s)
+        err = SDL.SDL_SetClipboardText(s.to_s.encode("UTF-8"))
+        raise SDLError if err < 0
+      end
+
+      # cpu info
+      #
+      def cpu_cache_line_size = SDL.SDL_GetCPUCacheLineSize
+
+      def cpu_count = SDL.SDL_GetCPUCount
+
+      def system_ram = SDL.SDL_GetSystemRAM
+
+      # error
+      #
+      def last_error_message = SDL.SDL_GetError.to_s
+
+      def last_error_message=(s)
+        SDL.SDL_SetError(s.to_s.gsub(/%/, "%%"))
+      end
+
+      # filesystem
+      #
+      def base_path
+        ptr = SDL.SDL_GetBasePath
+        raise SDLError if ptr.null?
+
+        ptr.free = SDL_FREE
+        ptr.to_s
+      end
+
+      # locale
+      #
+      def locales
+        ptr = SDL.SDL_GetPreferredLocales
+        return [] if ptr.null?
+
+        ptr.free = SDL_FREE
+        size = SDL_Locale.size
+        (0..).inject([]) do |memo, i|
+          st = SDL_Locale.new(ptr + i * size)
+          break memo if st.language.null?
+          memo << [st.language.to_s,
+                   (c = st.country).null? ? nil : c.to_s]
+        end
+      end
+
+      # message box
+      #
+      def alert(message, title = nil, flags: nil, window: nil)
+        err = SDL.SDL_ShowSimpleMessageBox(flags,
+                                           title.to_s.encode("UTF-8"),
+                                           message.to_s.encode("UTF-8"),
+                                           window)
+        raise SDLError if err < 0
+      end
+
+      def error_alert(message, title = "Error")
+        alert(message, title, flags: SDL_MESSAGEBOX_ERROR)
+      end
+
+      def warn_alert(message, title = "Warning")
+        alert(message, title, flags: SDL_MESSAGEBOX_WARNING)
+      end
+
+      def info_alert(message, title = "Information")
+        alert(message, title, flags: SDL_MESSAGEBOX_INFORMATION)
+      end
+
+      # misc
+      #
+      def open_url(url)
+        raise SDLError if SDL.SDL_OpenURL(url) < 0
+      end
+
+      # platform
+      #
+      def platform = SDL.SDL_GetPlatform.to_s
+
+      # timer
+      #
+      def ticks = Timer.ticks
+
+      # version
+      #
+      def revision = SDL.SDL_GetRevision.to_s
+
+      def version
+        st = SDL_version.malloc(Fiddle::RUBY_FREE)
+        SDL.SDL_GetVersion(st)
+        st.to_a.join(".")
+      end
+
+      # video
+      #
+      def video_driver
+        (ptr = SDL.SDL_GetCurrentVideoDriver).null? ? nil : ptr.to_s
+      end
+
+      def screen_saver=(b)
+        b ? SDL.SDL_EnableScreenSaver : SDL.SDL_DisableScreenSaver
+      end
+
+      def screen_saver? = SDL.SDL_IsScreenSaverEnabled != 0
+
+      def video_drivers
+        SDL.SDL_GetNumVideoDrivers.times.map do |i|
+          (ptr = SDL.SDL_GetVideoDriver(i)).null? ? nil : ptr.to_s
+        end
+      end
+    end
+  end
+end

data/lib/SDLRuby/timer.rb

@@ -0,0 +1,25 @@
+module SDLRuby
+  module Timer
+    class << self
+      def ticks
+        # Use the same Ticks as the one utilized for SDL event timestamps.
+        #
+        SDL.SDL_GetTicks
+      end
+
+      def inspect
+        n = SDL.SDL_GetTicks64
+        epoch_time = n / 1000
+
+        sprintf(
+          "%d %02d:%02d:%02d.%03d0000",
+          epoch_time / 86400,     # days
+          epoch_time / 3600 % 24, # hours
+          epoch_time / 60 % 60,   # minutes
+          epoch_time % 60,        # seconds
+          n % 1000                # fractional seconds
+        )
+      end
+    end
+  end
+end

data/lib/SDLRuby/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module SDLRuby
-  VERSION = "0.2.1"
+  VERSION = "0.3.1"
 end

data/lib/SDLRuby/window/surfacer.rb

@@ -1,37 +1,37 @@
-module SDLRuby
-  class Window
-    module Surfacer
-      include SDL
-
-      def destroy_surface
-        err = SDL.SDL_DestroyWindowSurface(self)
-        raise SDLError if err < 0
-      end
-
-      def surface
-        ptr = SDL.SDL_GetWindowSurface(self)
-        raise SDLError if ptr.null?
-
-        # ウィンドウからのサーフェスにはSDL_DONTFREEフラグが設定されている。
-        # このためにSDL_FreeSurfaceではリファレンスカウンターを減じる事ができない。
-        # これはRubyのGC管理では問題になる（メモリーリークする）。
-        # そのためSDL_DONTFREEフラグを解除する！
-        #
-        st = SDL_Surface.new(ptr)
-        st.flags &= ~SDL_DONTFREE
-
-        Surface.new(ptr, add_ref: true)
-      end
-
-      # ウィンドウのサーフェスがvalidかどうか確認していない。
-      # リサイズなどで壊れていてもtrueを戻す。
-      #
-      def surface? = SDL.SDL_HasWindowSurface(self) == 1
-
-      def update_surface
-        err = SDL.SDL_UpdateWindowSurface(self)
-        raise SDLError if err < 0
-      end
-    end
-  end
-end
+module SDLRuby
+  class Window
+    module Surfacer
+      include SDL
+
+      def destroy_surface
+        err = SDL.SDL_DestroyWindowSurface(self)
+        raise SDLError if err < 0
+      end
+
+      def surface
+        ptr = SDL.SDL_GetWindowSurface(self)
+        raise SDLError if ptr.null?
+
+        # ウィンドウからのサーフェスにはSDL_DONTFREEフラグが設定されている。
+        # このためにSDL_FreeSurfaceではリファレンスカウンターを減じる事ができない。
+        # これはRubyのGC管理では問題になる（メモリーリークする）。
+        # そのためSDL_DONTFREEフラグを解除する！
+        #
+        st = SDL_Surface.new(ptr)
+        st.flags &= ~SDL_DONTFREE
+
+        Surface.new(ptr, add_ref: true)
+      end
+
+      # ウィンドウのサーフェスがvalidかどうか確認していない。
+      # リサイズなどで壊れていてもtrueを戻す。
+      #
+      def surface? = SDL.SDL_HasWindowSurface(self) == 1
+
+      def update_surface
+        err = SDL.SDL_UpdateWindowSurface(self)
+        raise SDLError if err < 0
+      end
+    end
+  end
+end

data/sig/lib/SDLRuby/keyboard.rbs

@@ -0,0 +1,25 @@
+module SDLRuby
+  module Keyboard
+    include SDL
+
+    def self.==: (untyped other) -> bool
+
+    def self.any?: () -> bool
+
+    def self.clear: () -> void
+
+    def self.mod: () -> Integer
+
+    def self.scancode: (String | Symbol s) -> Integer
+
+    def self.scancode_name: (Integer num) -> String
+
+    def self.size: () -> Integer
+
+    alias self.length self.size
+
+    def self.to_a: () -> Array[Integer]
+
+    def self.to_str: () -> String
+  end
+end

data/sig/lib/SDLRuby/mouse.rbs

@@ -0,0 +1,35 @@
+module SDLRuby
+  module Mouse
+    include SDL
+
+    def self.button: () -> Array[bool]
+
+    def self.capture=: (boolish) -> void
+
+    def self.global_button: () -> Array[bool]
+
+    def self.global_pos: () -> [Integer, Integer]
+
+    def self.global_pos=: ([Integer, Integer] xy) -> void
+
+    def self.global_state: () -> [Array[bool], Integer, Integer]
+
+    def self.pos: () -> [Integer, Integer]
+
+    def self.pos=: ([Integer, Integer] xy) -> void
+
+    def self.relative=: (boolish) -> untyped
+
+    def self.relative?: () -> bool
+
+    def self.relative_pos: () -> [Integer, Integer]
+
+    def self.relative_state: () -> [Array[bool], Integer, Integer]
+
+    def self.state: () -> [Array[bool], Integer, Integer]
+
+    private
+
+    def self.button_to_ary: (Integer num) -> ::Array[bool]
+  end
+end

data/sig/lib/SDLRuby/timer.rbs

@@ -0,0 +1,7 @@
+module SDLRuby
+  module Timer
+    def self.ticks: () -> Integer
+
+    def self.inspect: () -> String
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: SDLRuby
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.3.1
 platform: ruby
 authors:
 - shinokaro
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2023-09-12 00:00:00.000000000 Z
+date: 2023-09-27 00:00:00.000000000 Z
 dependencies: []
 description: 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
@@ -51,7 +51,13 @@ files:
 - lib/SDLRuby/renderer/accessor.rb
 - lib/SDLRuby/renderer/drawer.rb
 - lib/SDLRuby/renderer/renderer_info.rb
+- lib/SDLRuby/rw/operational.rb
+- lib/SDLRuby/rw/read_closure.rb
+- lib/SDLRuby/rw/seek_closure.rb
+- lib/SDLRuby/rw/size_closure.rb
+- lib/SDLRuby/rw/write_closure.rb
 - lib/SDLRuby/rw_ops.rb
+- lib/SDLRuby/rw_ops/mem_close.rb
 - lib/SDLRuby/rw_ops/rw_object.rb
 - lib/SDLRuby/sdl.rb
 - lib/SDLRuby/sdl/include/SDL.h.rb
@@ -102,6 +108,7 @@ files:
 - lib/SDLRuby/surface/surface_renderer.rb
 - lib/SDLRuby/text_input.rb
 - lib/SDLRuby/texture.rb
+- lib/SDLRuby/timer.rb
 - lib/SDLRuby/ttf.rb
 - lib/SDLRuby/ttf/include/SDL_ttf.h.rb
 - lib/SDLRuby/ttf/ttf.rb
@@ -122,7 +129,10 @@ files:
 - sig/lib/SDLRuby/event.rbs
 - sig/lib/SDLRuby/event/accessor.rbs
 - sig/lib/SDLRuby/event/type.rbs
+- sig/lib/SDLRuby/keyboard.rbs
+- sig/lib/SDLRuby/mouse.rbs
 - sig/lib/SDLRuby/sdl.rbs
+- sig/lib/SDLRuby/timer.rbs
 homepage: https://github.com/shinokaro/SDLRuby
 licenses:
 - MIT